Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(api): use geojson-pydantic as request model #824

Merged
merged 1 commit into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

- report endpoint: has been deleted ([#818])


### Other Changes

- a new regression test suite has been added to support safer deployments of new versions ([#820])

- use Pydantic model from the `geojson-pydantic` library as request model for `bpolys` ([#824])


[#818]: https://github.com/GIScience/ohsome-quality-api/pull/818
[#820]: https://github.com/GIScience/ohsome-quality-api/issues/820
[#824]: https://github.com/GIScience/ohsome-quality-api/issues/824


## Release 1.4.0
Expand Down
21 changes: 11 additions & 10 deletions ohsome_quality_api/api/request_models.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
import json
from typing import Dict

import geojson
from geojson import FeatureCollection
from geojson_pydantic import Feature, FeatureCollection, MultiPolygon, Polygon
from pydantic import BaseModel, ConfigDict, Field, field_validator

from ohsome_quality_api.attributes.definitions import AttributeEnum
from ohsome_quality_api.topics.definitions import TopicEnum
from ohsome_quality_api.topics.models import TopicData
from ohsome_quality_api.utils.helper import snake_to_lower_camel
from ohsome_quality_api.utils.validators import validate_geojson


class BaseConfig(BaseModel):
Expand All @@ -20,8 +19,11 @@ class BaseConfig(BaseModel):
)


FeatureCollection_ = FeatureCollection[Feature[Polygon | MultiPolygon, Dict]]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume the underscore postfix is for avoiding name collisions?



class BaseBpolys(BaseConfig):
bpolys: dict = Field(
bpolys: FeatureCollection_ = Field(
{
"type": "FeatureCollection",
"features": [
Expand All @@ -46,12 +48,11 @@ class BaseBpolys(BaseConfig):

@field_validator("bpolys")
@classmethod
def validate_bpolys(cls, value) -> FeatureCollection:
obj = geojson.loads(json.dumps(value))
if not isinstance(obj, FeatureCollection):
raise ValueError("must be of type FeatureCollection")
validate_geojson(obj) # Check if exceptions are raised
return obj
def transform(cls, value) -> geojson.FeatureCollection:
# NOTE: `geojson_pydantic` library is used only for validation and openAPI-spec
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good explanation ;)

# generation. To avoid refactoring all code the FeatureCollection object of
# the `geojson` library is still used every else.
return geojson.loads(value.model_dump_json())


class IndicatorRequest(BaseBpolys):
Expand Down