From 4be79776cb6d26a2e8181322aceaade932229e7f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Laura=20Kl=C3=BCnder?= <laura@codingcatgirl.de>
Date: Mon, 4 Dec 2023 13:55:24 +0100
Subject: [PATCH] update BoundsSchema docs

---
 src/c3nav/api/api.py                   |  3 ++-
 src/c3nav/mapdata/api/updates.py       |  5 +++--
 src/c3nav/mapdata/schemas/responses.py | 16 +++++++++++++---
 3 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/src/c3nav/api/api.py b/src/c3nav/api/api.py
index 4666f18d..ff262c28 100644
--- a/src/c3nav/api/api.py
+++ b/src/c3nav/api/api.py
@@ -1,5 +1,6 @@
 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 c3nav.api.auth import APIKeyType, auth_responses
diff --git a/src/c3nav/mapdata/api/updates.py b/src/c3nav/mapdata/api/updates.py
index ecf04ccc..5063cc2f 100644
--- a/src/c3nav/mapdata/api/updates.py
+++ b/src/c3nav/mapdata/api/updates.py
@@ -1,8 +1,9 @@
-from typing import Optional, Union, Annotated
+from typing import Annotated, Optional, Union
 from urllib.parse import urlparse
 
 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 pydantic import PositiveInt
 
diff --git a/src/c3nav/mapdata/schemas/responses.py b/src/c3nav/mapdata/schemas/responses.py
index f440c187..f609ad93 100644
--- a/src/c3nav/mapdata/schemas/responses.py
+++ b/src/c3nav/mapdata/schemas/responses.py
@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Annotated, Optional
 
 from ninja import Schema
 from pydantic import Field as APIField
@@ -12,8 +12,18 @@ class BoundsSchema(Schema):
     """
     Describing a bounding box
     """
-    bounds: tuple[tuple[float, float], tuple[float, float]] = APIField(
-        description="(x, y) to (x, y)",
+    bounds: tuple[
+        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)),
     )