2025-summer/team-3
12
Fork 0
Code Issues Pull requests Projects Releases Activity

some better API annotations

Browse source
This commit is contained in:
Laura Klünder 2023-11-23 18:16:56 +01:00
parent 87e5e56ea1
commit 3fd5c49926
1 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/c3nav/mapdata/schemas/model_base.py
View file

@ -1,4 +1,4 @@
from typing import Any, ClassVar, Optional
from typing import Any, ClassVar, Optional, Annotated
from ninja import Schema
from pydantic import Field as APIField
@ -172,9 +172,14 @@ class SimpleGeometryBoundsSchema(Schema):
class SimpleGeometryBoundsAndPointSchema(SimpleGeometryBoundsSchema):
point: tuple[PositiveInt, float, float] = APIField(
title="point representation of the location",
description="made from the level ID, X and Y in this order",
point: tuple[
Annotated[PositiveInt, APIField(title="level ID")],
Annotated[float, APIField(title="x coordinate")],
Annotated[float, APIField(title="y coordinate")]
] = APIField(
title="point representation",
description="representative point for the location",
example=(1, 4.2, 13.37)
)