update BoundsSchema docs
This commit is contained in:
parent
87ef037421
commit
4be79776cb
3 changed files with 18 additions and 6 deletions
|
@ -1,5 +1,6 @@
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from ninja import Router as APIRouter, Field as APIField
|
from ninja import Field as APIField
|
||||||
|
from ninja import Router as APIRouter
|
||||||
from ninja import Schema
|
from ninja import Schema
|
||||||
|
|
||||||
from c3nav.api.auth import APIKeyType, auth_responses
|
from c3nav.api.auth import APIKeyType, auth_responses
|
||||||
|
|
|
@ -1,8 +1,9 @@
|
||||||
from typing import Optional, Union, Annotated
|
from typing import Annotated, Optional, Union
|
||||||
from urllib.parse import urlparse
|
from urllib.parse import urlparse
|
||||||
|
|
||||||
from django.http import HttpResponse
|
from django.http import HttpResponse
|
||||||
from ninja import Router as APIRouter, Field as APIField
|
from ninja import Field as APIField
|
||||||
|
from ninja import Router as APIRouter
|
||||||
from ninja import Schema
|
from ninja import Schema
|
||||||
from pydantic import PositiveInt
|
from pydantic import PositiveInt
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
from typing import Optional
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
from ninja import Schema
|
from ninja import Schema
|
||||||
from pydantic import Field as APIField
|
from pydantic import Field as APIField
|
||||||
|
@ -12,8 +12,18 @@ class BoundsSchema(Schema):
|
||||||
"""
|
"""
|
||||||
Describing a bounding box
|
Describing a bounding box
|
||||||
"""
|
"""
|
||||||
bounds: tuple[tuple[float, float], tuple[float, float]] = APIField(
|
bounds: tuple[
|
||||||
description="(x, y) to (x, y)",
|
Annotated[tuple[
|
||||||
|
Annotated[float, APIField(title="left", description="lowest X coordindate")],
|
||||||
|
Annotated[float, APIField(title="bottom", description="lowest Y coordindate")]
|
||||||
|
], APIField(title="(left, bottom)", description="lowest coordinates")],
|
||||||
|
Annotated[tuple[
|
||||||
|
Annotated[float, APIField(title="right", description="highest X coordindate")],
|
||||||
|
Annotated[float, APIField(title="top", description="highest Y coordindate")]
|
||||||
|
], APIField(title="(right, top)", description="highest coordinates")]
|
||||||
|
] = APIField(
|
||||||
|
title="boundaries",
|
||||||
|
description="(left, bottom) to (top, right)",
|
||||||
example=((-10, -20), (20, 30)),
|
example=((-10, -20), (20, 30)),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue