Merge pull request #45 from ecmwf-projects/387-get-jobs-extension

Extend StatusInfo model to allow for metadata field

Author: mcucchi9

ogc_api_processes_fastapi/clients.py

@@ -75,7 +75,7 @@ def post_process_execute(
         execution_content: models.Execute,
         request: fastapi.Request,
         response: fastapi.Response,
-    ) -> Dict[str, Any]:
+    ) -> models.StatusInfo:
         """Post request for execution of the process identified by `process_id`.
 
         Called with `POST /processes/{process_id}/execute`.
@@ -158,7 +158,7 @@ def get_job_results(self, job_id: str) -> Dict[str, Any]:
 
         Returns
         -------
-        Dict[str, Any]
+        dict[str, Any]
             Job results.
 
         Raises

ogc_api_processes_fastapi/models.py

@@ -245,6 +245,9 @@ class JobType(enum.Enum):
 class GenericObject(pydantic.BaseModel):
     __root__: Dict[str, Any]
 
+    def pop(self, key: str) -> Any:
+        return self.__root__.pop(key)
+
 
 class StatusInfo(pydantic.BaseModel):
     processID: Optional[str] = None
@@ -257,7 +260,7 @@ class StatusInfo(pydantic.BaseModel):
     finished: Optional[datetime] = None
     updated: Optional[datetime] = None
     progress: Optional[ConInt] = None
-    metadata: Optional[GenericObject] = None
+    metadata: GenericObject = GenericObject(__root__={})
     links: Optional[List[Link]] = None
 
 

ogc_api_processes_fastapi/routers.py

@@ -205,7 +205,7 @@ def post_process_execute(
             request=request,
             response=response,
         )
-        status_info["links"] = [
+        status_info.links = [
             models.Link(
                 href=urllib.parse.urljoin(
                     str(request.base_url), f"processes/{process_id}/execute"
@@ -215,15 +215,15 @@ def post_process_execute(
             ),
             models.Link(
                 href=urllib.parse.urljoin(
-                    str(request.base_url), f"jobs/{status_info['jobID']}"
+                    str(request.base_url), f"jobs/{status_info.jobID}"
                 ),
                 rel="monitor",
                 type="application/json",
                 title="job status info",
             ),
         ]
         response.headers["Location"] = urllib.parse.urljoin(
-            str(request.base_url), f"jobs/{status_info['jobID']}"
+            str(request.base_url), f"jobs/{status_info.jobID}"
         )
 
         return status_info
@@ -320,6 +320,7 @@ def create_get_job_results_endpoint(
         "/{job_id}/results",
         response_model=models.Results,
         response_model_exclude_unset=True,
+        response_model_exclude_none=True,
         responses={
             404: {"description": "Job not found", "model": models.Exception},
         },
@@ -328,7 +329,6 @@ def create_get_job_results_endpoint(
     def get_job_results(job_id: str) -> Dict[str, Any]:
         """Show results of a job."""
         response = client.get_job_results(job_id=job_id)
-
         return response
 
 

tests/conftest.py

@@ -63,8 +63,8 @@ def post_process_execute(
         execution_content: models.Execute,
         request: fastapi.Request,
         response: fastapi.Response,
-    ) -> Dict[str, Any]:
-        status_info = dict(
+    ) -> models.StatusInfo:
+        status_info = models.StatusInfo(
             jobID=1, status=models.StatusCode.accepted, type=models.JobType.process
         )
         return status_info