Added cads:disabled_reason and JSON schema definition (#71)

* Added cads:disabled_reason and JSON schema definition

* Made mypy happier

Author: keul

cads_catalogue_api_service/client.py

@@ -425,8 +425,11 @@ def collection_serializer(
         # FIXME: this is not a 100% correct implementation of the STAC scientific extension.
         # One of the sci:xxx should be there, but CAMS dataset are not doing this
         **({"sci:doi": db_model.doi} if db_model.doi else {}),
+        # *****************************************
         # *** CADS specific extension properties ***
+        # *****************************************
         **({"cads:message": active_message} if active_message else {}),
+        "cads:disabled_reason": db_model.disabled_reason,
     }
 
     if schema_org:
@@ -449,9 +452,9 @@ def collection_serializer(
         keywords=[keyword.keyword_name for keyword in db_model.keywords],
         # https://github.com/radiantearth/stac-spec/blob/master/collection-spec/collection-spec.md#license
         # note that this small check, evenif correct, is triggering a lot of subrequests
-        license="various"
-        if not preview and len(db_model.licences) > 1
-        else "proprietary",
+        license=(
+            "various" if not preview and len(db_model.licences) > 1 else "proprietary"
+        ),
         extent=get_extent(db_model),
         links=collection_links,
         **additional_properties,

cads_catalogue_api_service/exceptions.py

@@ -64,7 +64,7 @@ def add_exception_handlers(
         app.add_exception_handler(exc, exception_handler_factory(code))
 
     def request_validation_exception_handler(
-        request: fastapi.Request, exc: fastapi.exceptions.RequestValidationError
+        request: fastapi.Request, exc: Exception
     ) -> fastapi.responses.JSONResponse:
         return generate_exception_response(
             title="submitted data is not valid",
@@ -94,7 +94,8 @@ def __init__(self, message: str = "This STAC feature is not implemented yet."):
 
 def generate_exception_response(
     title, detail=None, status_code=starlette.status.HTTP_500_INTERNAL_SERVER_ERROR
-):
+) -> fastapi.responses.JSONResponse:
+    """Build standard JSON error response."""
     return fastapi.responses.JSONResponse(
         status_code=status_code,
         content={

cads_catalogue_api_service/vocabularies.py

@@ -72,7 +72,7 @@ def query_licences(
         .order_by(cads_catalogue.database.Licence.title)
         .all()
     )
-    return results
+    return results  # type: ignore
 
 
 def query_licence(
@@ -101,12 +101,12 @@ def query_licence(
             .order_by(cads_catalogue.database.Licence.title)
             .one()
         )
-    except sa.exc.NoResultFound:
+    except sa.exc.NoResultFound as exc:
         raise fastapi.HTTPException(
             status_code=fastapi.status.HTTP_404_NOT_FOUND,
             detail=f"licence {licence_uid} not found",
-        )
-    return results
+        ) from exc
+    return results  # type: ignore
 
 
 def query_keywords(

schemas/dataset_preview.json

@@ -19,6 +19,11 @@
     "license": {
       "enum": ["various", "proprietary"]
     },
+    "cads:disabled_reason": {
+      "type": ["string", "null"],
+      "title": "Reason why download is disabled",
+      "description": "The reason why the download form on this this dataset will not be enabled to standard users"
+    },
     "cads:message": {
       "type": "object",
       "title": "Latest message related to this dataset",

tests/testing.py

@@ -72,6 +72,7 @@ def get_record(id: str) -> cads_catalogue.database.Resource:
             )
         ],
         qa_flag=True,
+        disabled_reason="Disabled because of a reason",
     )
 
 
@@ -174,6 +175,7 @@ def generate_expected(
         "published": "2020-01-01T00:00:00Z",
         "updated": "2020-02-05T00:00:00Z",
         "sci:doi": "11.2222/cads.12345",
+        "cads:disabled_reason": "Disabled because of a reason",
     }
     if not preview:
         expected = {