some more documentation in the API and in the API code

This commit is contained in:
Laura Klünder 2023-11-19 00:12:10 +01:00
parent f96e916184
commit 0f43274e33
8 changed files with 126 additions and 24 deletions

View file

@ -3,4 +3,10 @@ from pydantic import Field as APIField
class BoundsSchema(Schema):
bounds: tuple[tuple[float, float], tuple[float, float]] = APIField(..., example=((-10, -20), (20, 30)))
"""
Describing a bounding box
"""
bounds: tuple[tuple[float, float], tuple[float, float]] = APIField(
description="(x, y) to (x, y)",
example=((-10, -20), (20, 30)),
)