Merge pull request #206 from ecmwf-projects/COPDS-797-inject-endpoints-doc

Define custom endpoints description

Author: mcucchi9

cads_processing_api_service/clients.py

@@ -70,6 +70,16 @@ class DatabaseClient(ogc_api_processes_fastapi.clients.BaseClient):
     process_data_table = cads_catalogue.database.ResourceData
     job_table = cads_broker.database.SystemRequest
 
+    endpoints_description = {
+        "GetProcesses": "Get the list of available processes' summaries.",
+        "GetProcess": "Get the description of the process identified by `process_id`.",
+        "PostProcessExecution": "Request execution of a process.",
+        "GetJobs": "Get the list of submitted jobs, alongside information on their status.",
+        "GetJob": "Get status information for the job identifed by `job_id`.",
+        "GetJobResults": "Get results for the job identifed by `job_id`.",
+        "DeleteJob": "Dismiss the job identifed by `job_id`.",
+    }
+
     def get_processes(
         self,
         limit: int | None = fastapi.Query(10, ge=1, le=10000),

cads_processing_api_service/main.py

@@ -65,16 +65,19 @@ async def lifespan(application: fastapi.FastAPI) -> AsyncGenerator[Any, None]:
 app.router.add_api_route(
     "/processes/{process_id}/constraints",
     constraints.apply_constraints,
+    description="Apply constraints to the submitted process execution.",
     methods=["POST"],
 )
 app.router.add_api_route(
     "/processes/{process_id}/costing",
     costing.estimate_costs,
+    description="Estimate costs of the submitted process execution.",
     methods=["POST"],
 )
 app.router.add_api_route(
     "/processes/{process_id}/api-request",
     translators.get_api_request,
+    description="Get API request equivalent to the submitted prrocess execution json.",
     methods=["POST"],
 )