Merge pull request #207 from ecmwf-projects/COPDS-2041-warn-execute-deprecation

Add warning message for deprecated /execute endpoint

Author: mcucchi9

cads_processing_api_service/clients.py

@@ -177,6 +177,7 @@ def get_process(
 
     def post_process_execution(
         self,
+        api_request: fastapi.Request,
         process_id: str = fastapi.Path(...),
         execution_content: models.Execute = fastapi.Body(...),
         auth_header: tuple[str, str] = fastapi.Depends(auth.get_auth_header),
@@ -270,6 +271,14 @@ def post_process_execution(
             )
             for message in dataset.messages
         ]
+        url = str(api_request.url)
+        if url.rstrip("/").endswith("execute"):
+            message = models.DatasetMessage(
+                date=datetime.datetime.now(),
+                severity="WARNING",
+                content=config.ensure_settings().deprecation_warning_message,
+            )
+            dataset_messages.append(message)
         status_info = utils.make_status_info(
             job, dataset_metadata={"messages": dataset_messages}
         )

cads_processing_api_service/config.py

@@ -34,6 +34,11 @@
     "{licences}"
 )
 
+DEPRECATION_WARNING_MESSAGE = (
+    "You are using a deprecated API endpoint. "
+    "If you are using cdsapi, please upgrade to the latest version."
+)
+
 general_settings = None
 
 
@@ -57,6 +62,7 @@ class Settings(pydantic_settings.BaseSettings):
     api_request_template: str = API_REQUEST_TEMPLATE
     missing_dataset_title: str = "Dataset not available"
     anonymous_licences_message: str = ANONYMOUS_LICENCES_MESSAGE
+    deprecation_warning_message: str = DEPRECATION_WARNING_MESSAGE
 
     @property
     def profiles_api_url(self) -> str: