Refactor: Add examples to API docs for datetime

EURODEO · Feb 7, 2024 · 2fb606a · 2fb606a · github-actions · Feb 7, 2024
1 parent 5cee99e
commit 2fb606a
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/api/routers/edr.py b/api/routers/edr.py
@@ -62,7 +62,7 @@ async def get_locations(bbox: str = Query(..., example="5.0,52.0,6.0,52.1")) ->
 async def get_data_location_id(
     location_id: str = Path(..., example="06260"),
     parameter_name: str = Query(None, alias="parameter-name", example="dd,ff,rh,pp,tn"),
-    datetime: str | None = None,
+    datetime: str = Query(None, example="2022-12-31T00:00Z/2023-01-01T00:00Z"),
     f: str = Query(default="covjson", alias="f", description="Specify return format."),
 ):
     # TODO: There is no error handling of any kind at the moment!
@@ -90,7 +90,7 @@ async def get_data_location_id(
 async def get_data_position(
     coords: str = Query(..., example="POINT(5.179705 52.0988218)"),
     parameter_name: str = Query(None, alias="parameter-name", example="dd,ff,rh,pp,tn"),
-    datetime: str | None = None,
+    datetime: str = Query(None, example="2022-12-31T00:00Z/2023-01-01T00:00Z"),
     f: str = Query(default="covjson", alias="f", description="Specify return format."),
 ):
     point = wkt.loads(coords)
@@ -108,7 +108,7 @@ async def get_data_position(
 async def get_data_area(
     coords: str = Query(..., example="POLYGON((5.0 52.0, 6.0 52.0,6.0 52.1,5.0 52.1, 5.0 52.0))"),
     parameter_name: str = Query(None, alias="parameter-name", example="dd,ff,rh,pp,tn"),
-    datetime: str | None = None,
+    datetime: str = Query(None, example="2022-12-31T00:00Z/2023-01-01T00:00Z"),
     f: str = Query(default="covjson", alias="f", description="Specify return format."),
 ):
     poly = wkt.loads(coords)