refactor: add docstrings and comments

GIScience · Nov 19, 2024 · 602899b · 602899b
1 parent cfd6ab6
commit 602899b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/ohsome_quality_api/api/request_models.py b/ohsome_quality_api/api/request_models.py
@@ -92,10 +92,12 @@ class AttributeCompletenessFilterRequest(IndicatorRequest):
     attribute_filter: str = Field(
         ...,
         title="Attribute Filter",
+        description="ohsome filter query representing custom attributes.",
     )
     attribute_names: List[str] = Field(
         ...,
         title="Attribute Names",
+        description="Names of the attributes represented by the Attribute Filter.",
     )
 
 

diff --git a/tests/integrationtests/api/test_indicators_atribute_completeness.py b/tests/integrationtests/api/test_indicators_atribute_completeness.py
@@ -58,7 +58,7 @@ def test_indicators_attribute_completeness_without_attribute(
     client,
     bpolys,
     headers,
-    schema,
+    schema,  # pyright:ignore
 ):
     parameters = {
         "bpolys": bpolys,
@@ -74,7 +74,7 @@ def test_indicators_attribute_completeness_with_invalid_attribute_for_topic(
     client,
     bpolys,
     headers,
-    schema,
+    schema,  # pyright: ignore
 ):
     parameters = {
         "bpolys": bpolys,