add description and source to quality dimensions

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Current Main
+
+### New Features
+
+- add source and description to quality dimensions ([#720])
+
+
+[#720]: https://github.com/GIScience/ohsome-quality-api/pull/720
+
 ## Release 1.3.0
 
 ### Breaking Changes

ohsome_quality_api/quality_dimensions/models.py

@@ -5,6 +5,7 @@
 class QualityDimension(BaseModel):
     name: str
     description: str
+    source: str | None = None
     model_config = ConfigDict(
         title="Topic",
         frozen=True,

ohsome_quality_api/quality_dimensions/quality_dimensions.yaml

@@ -1,20 +1,24 @@
 ---
-# TODO description
 
 completeness:
   name: Completeness
   description: >-
-    something that is still a TODO
+    The degree to which subject data associated with an entity has values for all expected attributes
+    and related entity instances in a specific context of use.
+  source:
+    https://www.iso.org/standard/78900.html
 
 currentness:
   name: Currentness
   description: >-
-    something that is still a TODO
+    The degree to which data has attributes that are of the right age in a specific context of use.
+  source:
+    https://www.iso.org/standard/35736.html
 
 minimal:
   name: Minimal
   description: >-
-    something that is still a TODO
+    A minimal quality dimension definition for testing purposes.
 
 none:
   name: None

tests/integrationtests/api/conftest.py

@@ -84,11 +84,13 @@ def metadata_report_multilevel_mapping_saturation():
 
 
 @pytest.fixture
-def metadata_quality_dimension_completeness():
+def metadata_quality_dimension():
     return {
-        "completeness": {
-            "name": "Completeness",
-            "description": "something that is still a TODO",
+        "minimal": {
+            "name": "Minimal",
+            "description": "A minimal quality dimension"
+            " definition for testing purposes.",
+            "source": None,
         }
     }
 

tests/integrationtests/api/test_metadata.py

@@ -8,7 +8,7 @@ def test_metadata(
     metadata_project_core,
     response_metadata_topic_building_count,
     metadata_indicator_mapping_saturation,
-    metadata_quality_dimension_completeness,
+    metadata_quality_dimension,
 ):
     response = client.get("/metadata")
     assert response.status_code == 200
@@ -23,8 +23,7 @@ def test_metadata(
     )
     # check quality dimensions result
     assert (
-        metadata_quality_dimension_completeness["completeness"]
-        == result["qualityDimensions"]["completeness"]
+        metadata_quality_dimension["minimal"] == result["qualityDimensions"]["minimal"]
     )
     # check projects result
     assert metadata_project_core["core"] == result["projects"]["core"]

tests/integrationtests/api/test_metadata_quality_dimensions.py

@@ -1,28 +1,25 @@
 def test_metadata_quality_dimensions(
-    client, response_template, metadata_quality_dimension_completeness
+    client, response_template, metadata_quality_dimension
 ):
     response = client.get("/metadata/quality-dimensions")
     assert response.status_code == 200
 
     content = response.json()
     result = content.pop("result")
     assert content == response_template
-    assert (
-        metadata_quality_dimension_completeness["completeness"]
-        == result["completeness"]
-    )
+    assert metadata_quality_dimension["minimal"] == result["minimal"]
 
 
 def test_metadata_quality_dimensions_by_key(
-    client, response_template, metadata_quality_dimension_completeness
+    client, response_template, metadata_quality_dimension
 ):
-    response = client.get("/metadata/quality-dimensions/completeness")
+    response = client.get("/metadata/quality-dimensions/minimal")
     assert response.status_code == 200
 
     content = response.json()
     result = content.pop("result")
     assert content == response_template
-    assert result == metadata_quality_dimension_completeness
+    assert result == metadata_quality_dimension
 
 
 def test_metadata_quality_dimensions_by_key_not_found_error(client):