COPDS-2801: spdx_identifier in licence APIs (#118)

* feat: spdx_identifier in licence APIs

* test: spdx_identifier

* chore: licences.json schema update

Author: alfredotoselli

cads_catalogue_api_service/models/base.py

@@ -37,6 +37,7 @@ class Licence(TypedDict):
     attachment_url: str
     scope: LicenceCategories | str | None
     portal: str | None
+    spdx_identifier: str | None
 
 
 class Licences(TypedDict):

cads_catalogue_api_service/vocabularies.py

@@ -60,6 +60,7 @@ def query_licences(
         cads_catalogue.database.Licence.revision,
         cads_catalogue.database.Licence.scope,
         cads_catalogue.database.Licence.portal,
+        cads_catalogue.database.Licence.spdx_identifier,
     )
     if scope and scope != LicenceScopeCriterion.all:
         query = query.filter(cads_catalogue.database.Licence.scope == scope)
@@ -94,6 +95,7 @@ def query_licence(
         cads_catalogue.database.Licence.revision,
         cads_catalogue.database.Licence.scope,
         cads_catalogue.database.Licence.portal,
+        cads_catalogue.database.Licence.spdx_identifier,
     )
     query = query.filter(cads_catalogue.database.Licence.licence_uid == licence_uid)
     result = (
@@ -105,6 +107,7 @@ def query_licence(
             cads_catalogue.database.Licence.revision,
             cads_catalogue.database.Licence.scope,
             cads_catalogue.database.Licence.portal,
+            cads_catalogue.database.Licence.spdx_identifier,
         )
         .order_by(sa.desc("revision"))
         .first()
@@ -151,6 +154,7 @@ def list_licences(
                 ),
                 scope=licence.scope,
                 portal=licence.portal,
+                spdx_identifier=licence.spdx_identifier,
             )
             for licence in results
         ]
@@ -176,6 +180,7 @@ def licence_details(
         ),
         scope=licence.scope,
         portal=licence.portal,
+        spdx_identifier=licence.spdx_identifier,
     )
 
 

schemas/licences.json

@@ -18,16 +18,26 @@
           "revision": {
             "type": "number"
           },
-          "text": {
+          "contents_url": {
             "type": "string",
             "format": "uri"
           },
-          "file": {
+          "attachment_url": {
             "type": "string",
             "format": "uri"
+          },
+          "scope": {
+            "type": "string",
+            "enum": ["portal", "dataset"]
+          },
+          "portal": {
+            "type": ["string", "null"]
+          },
+          "spdx_identifier": {
+            "type": ["string", "null"]
           }
         },
-        "required": ["id", "label", "revision", "text"]
+        "required": ["id", "label", "revision", "contents_url", "attachment_url", "scope", "portal", "spdx_identifier"]
       }
     }
   },

tests/test_20_vocabularies.py

@@ -33,6 +33,7 @@
         md_filename="cc-by-4.0-1.md",
         download_filename="cc-by-4.0-1.pdf",
         scope="dataset",
+        spdx_identifier="CC-BY-4.0",
     ),
     cads_catalogue.database.Licence(
         licence_id=3,
@@ -106,6 +107,7 @@ def test_vocabularies_license(monkeypatch) -> None:
                 "attachment_url": "/document-storage/cc-by-4.0-1.pdf",
                 "contents_url": "/document-storage/cc-by-4.0-1.md",
                 "scope": "dataset",
+                "spdx_identifier": "CC-BY-4.0",
             },
             {
                 "id": "cc-by-sa-4.0",
@@ -115,6 +117,7 @@ def test_vocabularies_license(monkeypatch) -> None:
                 "attachment_url": "/document-storage/cc-by-4.0-2.pdf",
                 "contents_url": "/document-storage/cc-by-4.0-2.md",
                 "scope": "dataset",
+                "spdx_identifier": None,
             },
         ],
     }
@@ -139,6 +142,7 @@ def test_vocabulary_license(monkeypatch) -> None:
         "attachment_url": "/document-storage/cc-by-4.0-1.pdf",
         "contents_url": "/document-storage/cc-by-4.0-1.md",
         "scope": "dataset",
+        "spdx_identifier": "CC-BY-4.0",
     }