Adds OrderCollection type and returns for get_orders

Co-authored-by: Tyler <[email protected]>
Co-authored-by: Jarrett Keifer <[email protected]>

Author: 3 people

src/stapi_fastapi/backends/root_backend.py

@@ -2,11 +2,11 @@
 
 from fastapi import Request
 
-from stapi_fastapi.models.order import Order
+from stapi_fastapi.models.order import Order, OrderCollection
 
 
 class RootBackend(Protocol):
-    async def get_orders(self, request: Request) -> list[Order]:
+    async def get_orders(self, request: Request) -> OrderCollection:
         """
         Return a list of existing orders.
         """

src/stapi_fastapi/models/order.py

@@ -1,19 +1,25 @@
-from typing import Literal, TypeVar
+from typing import Literal
 
-from geojson_pydantic import Feature
+from geojson_pydantic import Feature, FeatureCollection
 from geojson_pydantic.geometries import Geometry
-from pydantic import StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
 
-from stapi_fastapi.models.opportunity import OpportunityPropertiesBase
 from stapi_fastapi.models.shared import Link
+from stapi_fastapi.types.datetime_interval import DatetimeInterval
 
-G = TypeVar("G", bound=Geometry)
-P = TypeVar("P", bound=OpportunityPropertiesBase)
 
+class OrderProperties(BaseModel):
+    datetime: DatetimeInterval
+    model_config = ConfigDict(extra="allow")
 
-class Order(Feature[G, P]):
+
+class Order(Feature[Geometry, OrderProperties]):
     # We need to enforce that orders have an id defined, as that is required to
     # retrieve them via the API
     id: StrictInt | StrictStr  # type: ignore
     type: Literal["Feature"] = "Feature"
     links: list[Link]
+
+
+class OrderCollection(FeatureCollection[Order]):
+    type: Literal["FeatureCollection"] = "FeatureCollection"

src/stapi_fastapi/routers/root_router.py

@@ -5,7 +5,7 @@
 
 from stapi_fastapi.backends.root_backend import RootBackend
 from stapi_fastapi.constants import TYPE_GEOJSON, TYPE_JSON
-from stapi_fastapi.models.order import Order
+from stapi_fastapi.models.order import Order, OrderCollection
 from stapi_fastapi.models.product import Product, ProductsCollection
 from stapi_fastapi.models.root import RootResponse
 from stapi_fastapi.models.shared import Link
@@ -112,7 +112,7 @@ def get_products(self, request: Request) -> ProductsCollection:
             ],
         )
 
-    async def get_orders(self, request: Request) -> list[Order]:
+    async def get_orders(self, request: Request) -> OrderCollection:
         orders = await self.backend.get_orders(request)
         for order in orders:
             order.links.append(

tests/backends.py

@@ -4,7 +4,7 @@
 from stapi_fastapi.backends.product_backend import ProductBackend
 from stapi_fastapi.exceptions import ConstraintsException, NotFoundException
 from stapi_fastapi.models.opportunity import Opportunity, OpportunityRequest
-from stapi_fastapi.models.order import Order
+from stapi_fastapi.models.order import Order, OrderCollection
 from stapi_fastapi.routers.product_router import ProductRouter
 
 
@@ -16,7 +16,7 @@ class MockRootBackend:
     def __init__(self, orders: MockOrderDB) -> None:
         self._orders = orders
 
-    async def get_orders(self, request: Request) -> list[Order]:
+    async def get_orders(self, request: Request) -> OrderCollection:
         """
         Show all orders.
         """