feat: Api documentation (#522)

* chore: add documentation

* chore: update names

* chore: update tag

cumulus_lambda_functions/uds_api/auth_admin_api.py

@@ -10,7 +10,7 @@
 
 router = APIRouter(
     prefix=f'/{WebServiceConstants.ADMIN}/auth',
-    tags=["Admin Records CRUD", "Admins-Only"],
+    tags=["Admin Records CRUD (Admins-Only)"],
     responses={404: {"description": "Not found"}},
 )
 

cumulus_lambda_functions/uds_api/custom_meta_admin_api.py

@@ -19,7 +19,7 @@
 
 @router.put("/custom_metadata/{tenant}")
 @router.put("/custom_metadata/{tenant}/")
-async def es_granules_index_setup(request: Request, tenant: str, venue: Union[str, None] = None, request_body: dict = {}):
+async def custom_metadata_add(request: Request, tenant: str, venue: Union[str, None] = None, request_body: dict = {}):
     LOGGER.debug(f'started es_granules_index_setup')
     auth_info = FastApiUtils.get_authorization_info(request)
     query_body = {
@@ -40,7 +40,7 @@ async def es_granules_index_setup(request: Request, tenant: str, venue: Union[st
 
 @router.get("/custom_metadata/{tenant}")
 @router.get("/custom_metadata/{tenant}/")
-async def es_granules_index_setup(request: Request, tenant: str, venue: Union[str, None] = None):
+async def custom_metadata_get(request: Request, tenant: str, venue: Union[str, None] = None):
     LOGGER.debug(f'started es_granules_index_setup')
     auth_info = FastApiUtils.get_authorization_info(request)
     query_body = {
@@ -61,7 +61,7 @@ async def es_granules_index_setup(request: Request, tenant: str, venue: Union[st
 
 @router.delete("/custom_metadata/{tenant}/destroy")
 @router.delete("/custom_metadata/{tenant}/destroy/")
-async def es_granules_index_setup(request: Request, tenant: str, venue: Union[str, None] = None):
+async def custom_metadata_destroy(request: Request, tenant: str, venue: Union[str, None] = None):
     LOGGER.debug(f'started es_granules_index_setup')
     auth_info = FastApiUtils.get_authorization_info(request)
     query_body = {
@@ -82,7 +82,7 @@ async def es_granules_index_setup(request: Request, tenant: str, venue: Union[st
 
 @router.delete("/custom_metadata/{tenant}")
 @router.delete("/custom_metadata/{tenant}/")
-async def es_granules_index_delete_setup(request: Request, tenant: str, venue: Union[str, None] = None):
+async def custom_metadata_delete(request: Request, tenant: str, venue: Union[str, None] = None):
     LOGGER.debug(f'started es_granules_index_delete_setup')
     auth_info = FastApiUtils.get_authorization_info(request)
     query_body = {

cumulus_lambda_functions/uds_api/misc_api.py

@@ -16,14 +16,21 @@
 
 router = APIRouter(
     prefix=f'/{WebServiceConstants.MISC}',
-    tags=["Granules CRUD API"],
+    tags=["Miscellaneous API"],
     responses={404: {"description": "Not found"}},
 )
 
 
 @router.get(f'/catalog_list')
 @router.get(f'/catalog_list/')
-async def stac_entry(request: Request, response: Response):
+async def catalog_list(request: Request, response: Response):
+    """
+    This is to list all catalogs for STAC Browser.
+    This doesn't require any authorization token.
+    :param request:
+    :param response:
+    :return:
+    """
     base_url = os.environ.get(WebServiceConstants.BASE_URL, f'{request.url.scheme}://{request.url.netloc}')
     base_url = base_url[:-1] if base_url.endswith('/') else base_url
     base_url = base_url if base_url.startswith('http') else f'https://{base_url}'
@@ -46,6 +53,15 @@ async def stac_entry(request: Request, response: Response):
 @router.get(f'/stac_entry')
 @router.get(f'/stac_entry/')
 async def stac_entry(request: Request, response: Response):
+    """
+    This is an API to start STAC Browser.
+    Optionally, it will add a required authorization cookie if available.
+    However, this endpoint should be called from a separate URL due to the infrastructure.
+
+    :param request:
+    :param response:
+    :return:
+    """
     request_headers = dict(request.headers)
     LOGGER.debug(f'stac_entry - request_headers: {request_headers}')
     print(request_headers)

cumulus_lambda_functions/uds_api/system_admin_api.py

@@ -11,7 +11,7 @@
 
 router = APIRouter(
     prefix=f'/{WebServiceConstants.ADMIN}/system',
-    tags=["System Admin Records CRUD"],
+    tags=["System Admin Records CRUD (Admins-Only)"],
     responses={404: {"description": "Not found"}},
 )