refactor: remove topic model with custom data

ohsome_quality_api/api/api.py

@@ -13,7 +13,6 @@
 )
 from fastapi.responses import JSONResponse
 from fastapi_i18n import i18n
-from geojson import FeatureCollection
 from starlette.exceptions import HTTPException as StarletteHTTPException
 from starlette.staticfiles import StaticFiles
 
@@ -28,7 +27,6 @@
 from ohsome_quality_api.api.request_models import (
     AttributeCompletenessFilterRequest,
     AttributeCompletenessKeyRequest,
-    IndicatorDataRequest,
     IndicatorRequest,
     LandCoverThematicAccuracyRequest,
     RoadsThematicAccuracyRequest,
@@ -71,10 +69,8 @@
 from ohsome_quality_api.utils.exceptions import (
     OhsomeApiError,
     SizeRestrictionError,
-    TopicDataSchemaError,
 )
 from ohsome_quality_api.utils.helper import (
-    get_class_from_key,
     get_project_root,
     json_serialize,
 )
@@ -182,11 +178,10 @@ async def validation_exception_handler(
     )
 
 
-@app.exception_handler(TopicDataSchemaError)
 @app.exception_handler(OhsomeApiError)
 @app.exception_handler(SizeRestrictionError)
 async def custom_exception_handler(
-    _: Request, exception: TopicDataSchemaError | OhsomeApiError | SizeRestrictionError
+    _: Request, exception: OhsomeApiError | SizeRestrictionError
 ):
     """Exception handler for custom exceptions."""
     return JSONResponse(
@@ -228,27 +223,6 @@ def empty_api_response() -> dict:
     }
 
 
-@app.post("/indicators/mapping-saturation/data", include_in_schema=False)
-async def post_indicator_ms(parameters: IndicatorDataRequest) -> CustomJSONResponse:
-    """Legacy support for computing the Mapping Saturation indicator for given data."""
-    indicators = await main.create_indicator(
-        key="mapping-saturation",
-        bpolys=parameters.bpolys,
-        topic=parameters.topic,
-        include_figure=parameters.include_figure,
-    )
-    geojson_object = FeatureCollection(
-        features=[i.as_feature(parameters.include_data) for i in indicators]
-    )
-    response = empty_api_response()
-    response["attribution"]["text"] = get_class_from_key(
-        class_type="indicator",
-        key="mapping-saturation",
-    ).attribution()
-    response["result"] = [feature.properties for feature in geojson_object.features]
-    return CustomJSONResponse(content=response, media_type=MEDIA_TYPE_JSON)
-
-
 @app.post(
     "/indicators/attribute-completeness",
     tags=["indicator"],

ohsome_quality_api/api/request_models.py

@@ -17,7 +17,7 @@
 from ohsome_quality_api.attributes.definitions import AttributeEnum, get_attributes
 from ohsome_quality_api.indicators.definitions import get_valid_indicators
 from ohsome_quality_api.topics.definitions import TopicEnum, get_topic_preset
-from ohsome_quality_api.topics.models import Topic, TopicData
+from ohsome_quality_api.topics.models import Topic
 from ohsome_quality_api.utils.helper import snake_to_lower_camel
 
 
@@ -228,14 +228,3 @@ def empty_string_to_none(cls, value):
         if value == "":
             return None
         return value
-
-
-class IndicatorDataRequest(BaseBpolys):
-    """Model for the `/indicators/mapping-saturation/data` endpoint.
-
-    The Topic consists of name, description and data.
-    """
-
-    topic: TopicData = Field(..., title="Topic", alias="topic")
-    include_figure: bool = True
-    include_data: bool = False

ohsome_quality_api/indicators/mapping_saturation/indicator.py

@@ -15,7 +15,7 @@
 from ohsome_quality_api.indicators.base import BaseIndicator
 from ohsome_quality_api.indicators.mapping_saturation import models
 from ohsome_quality_api.ohsome import client as ohsome_client
-from ohsome_quality_api.topics.models import Topic, TopicData
+from ohsome_quality_api.topics.models import Topic
 
 logger = logging.getLogger(__name__)
 
@@ -54,7 +54,7 @@ class MappingSaturation(BaseIndicator):
 
     def __init__(
         self,
-        topic: Topic | TopicData,
+        topic: Topic,
         feature: Feature,
         time_range: str = "2008-01-01//P1M",
     ) -> None:
@@ -253,20 +253,18 @@ def create_figure(self) -> None:
             title_text=_("Date"),
             ticks="outside",
         )
-        if isinstance(self.topic, TopicData):
-            fig.update_yaxes(title_text=_("Value"))
-        else:
-            aggregation_type_mapping = {
-                "area": _("Area"),
-                "count": _("Count"),
-                "length": _("Lenght"),
-                "perimeter": _("Perimeter"),
-                "area/density": _("Density"),
-            }
-
-            fig.update_yaxes(
-                title_text=aggregation_type_mapping[self.topic.aggregation_type]
-            )
+
+        aggregation_type_mapping = {
+            "area": _("Area"),
+            "count": _("Count"),
+            "length": _("Lenght"),
+            "perimeter": _("Perimeter"),
+            "area/density": _("Density"),
+        }
+
+        fig.update_yaxes(
+            title_text=aggregation_type_mapping[self.topic.aggregation_type]
+        )
 
         fig.update_layout(showlegend=True)
         # fixed legend, because we do not expect high contributions in 2008

ohsome_quality_api/main.py

@@ -6,7 +6,7 @@
 from geojson import Feature, FeatureCollection
 
 from ohsome_quality_api.indicators.base import BaseIndicator as Indicator
-from ohsome_quality_api.topics.models import Topic, TopicData
+from ohsome_quality_api.topics.models import Topic
 from ohsome_quality_api.utils.helper import get_class_from_key
 from ohsome_quality_api.utils.helper_asyncio import gather_with_semaphore
 from ohsome_quality_api.utils.validators import validate_area
@@ -17,7 +17,7 @@
 async def create_indicator(
     key: str,
     bpolys: FeatureCollection,
-    topic: TopicData | Topic,
+    topic: Topic,
     include_figure: bool = True,
     **kwargs,
 ) -> list[Indicator]:

ohsome_quality_api/ohsome/client.py

@@ -15,8 +15,8 @@
     from json import JSONDecodeError
 
 from ohsome_quality_api.config import get_config_value
-from ohsome_quality_api.topics.models import Topic, TopicData
-from ohsome_quality_api.utils.exceptions import OhsomeApiError, TopicDataSchemaError
+from ohsome_quality_api.topics.models import Topic
+from ohsome_quality_api.utils.exceptions import OhsomeApiError
 
 
 @singledispatch
@@ -66,35 +66,6 @@ async def _(
     return validate_query_results(response, attribute_filter, group_by_boundary)
 
 
-@query.register
-async def _(
-    topic: TopicData,
-    bpolys: Feature | FeatureCollection,
-    attribute_filter: str | None = False,
-    group_by_boundary: bool | None = False,
-    **_kargs,
-) -> dict:
-    """Validate data attached to the Topic object and return data.
-
-    Data will only be validated and returned immediately.
-    The ohsome API will not be queried.
-
-    Args:
-        topic: Topic with name, description and data attached to it.
-        bpolys: Feature for a single bounding (multi)polygon.
-            FeatureCollection for "group by boundaries" queries. In this case the
-            argument 'group_by' needs to be set to 'True'.
-        group_by: Group by boundary.
-    """
-    try:
-        return validate_query_results(topic.data, attribute_filter, group_by_boundary)
-    except SchemaError as error:
-        raise TopicDataSchemaError(
-            "Invalid Topic data input to the Mapping Saturation Indicator.",
-            error,
-        ) from error
-
-
 async def query_ohsome_api(url: str, data: dict) -> dict:
     """Query the ohsome API.
 

ohsome_quality_api/topics/models.py

@@ -51,9 +51,3 @@ def ensure_filter_geometry_or_type(cls, value: str) -> str:
             raise ValueError("Filter does not contain geometry or type specification.")
         else:
             return value
-
-
-class TopicData(BaseTopic):
-    """Includes the data associated with the topic."""
-
-    data: dict

ohsome_quality_api/utils/exceptions.py

@@ -1,7 +1,6 @@
 """Custom exception classes."""
 
 from fastapi_i18n import _
-from schema import SchemaError
 
 
 class OhsomeApiError(Exception):
@@ -31,9 +30,3 @@ class EmptyRecordError(DatabaseError):
     def __init__(self):
         self.name = "EmptyRecordError"
         self.message = _("Query returned no record.")
-
-
-class TopicDataSchemaError(Exception):
-    def __init__(self, message, schema_error: SchemaError):
-        self.name = "TopicDataSchemaError"
-        self.message = "{0}\n{1}".format(message, schema_error)