add order_parameters to product and order

Author: tylanderson

src/stapi_fastapi/backends/product_backend.py

@@ -5,7 +5,7 @@
 from fastapi import Request
 
 from stapi_fastapi.models.opportunity import Opportunity, OpportunityRequest
-from stapi_fastapi.models.order import Order
+from stapi_fastapi.models.order import Order, OrderRequest
 from stapi_fastapi.routers.product_router import ProductRouter
 
 
@@ -27,7 +27,7 @@ async def search_opportunities(
     async def create_order(
         self,
         product_router: ProductRouter,
-        search: OpportunityRequest,
+        search: OrderRequest,
         request: Request,
     ) -> Order:
         """

src/stapi_fastapi/models/order.py

@@ -6,6 +6,19 @@
 
 from stapi_fastapi.models.shared import Link
 from stapi_fastapi.types.datetime_interval import DatetimeInterval
+from stapi_fastapi.types.filter import CQL2Filter
+
+
+class OrderParametersBase(BaseModel): ...
+
+
+class OrderRequest(BaseModel):
+    datetime: DatetimeInterval
+    geometry: Geometry
+    # TODO: validate the CQL2 filter?
+    filter: CQL2Filter | None = None
+    order_parameters: OrderParametersBase | None = None
+    model_config = ConfigDict(strict=True)
 
 
 class OrderProperties(BaseModel):

src/stapi_fastapi/models/product.py

@@ -7,6 +7,7 @@
 from pydantic import AnyHttpUrl, BaseModel, Field
 
 from stapi_fastapi.models.opportunity import OpportunityPropertiesBase
+from stapi_fastapi.models.order import OrderParametersBase
 from stapi_fastapi.models.shared import Link
 
 if TYPE_CHECKING:
@@ -45,18 +46,21 @@ class Product(BaseModel):
 
     # we don't want to include these in the model fields
     _constraints: type[OpportunityPropertiesBase]
+    _order_parameters: type[OrderParametersBase]
     _backend: ProductBackend
 
     def __init__(
         self,
         *args,
         backend: ProductBackend,
         constraints: type[OpportunityPropertiesBase],
+        order_parameters: type[OrderParametersBase],
         **kwargs,
     ) -> None:
         super().__init__(*args, **kwargs)
         self._backend = backend
         self._constraints = constraints
+        self._order_parameters = order_parameters
 
     @property
     def backend(self: Self) -> ProductBackend:
@@ -66,6 +70,10 @@ def backend(self: Self) -> ProductBackend:
     def constraints(self: Self) -> type[OpportunityPropertiesBase]:
         return self._constraints
 
+    @property
+    def order_parameters(self: Self) -> type[OrderParametersBase]:
+        return self._order_parameters
+
     def with_links(self: Self, links: list[Link] | None = None) -> Self:
         if not links:
             return self

src/stapi_fastapi/routers/product_router.py

@@ -11,7 +11,7 @@
     OpportunityCollection,
     OpportunityRequest,
 )
-from stapi_fastapi.models.order import Order
+from stapi_fastapi.models.order import Order, OrderRequest
 from stapi_fastapi.models.product import Product
 from stapi_fastapi.models.shared import Link
 from stapi_fastapi.responses import GeoJSONResponse
@@ -59,6 +59,14 @@ def __init__(
             summary="Get constraints for the product",
         )
 
+        self.add_api_route(
+            path="/order-parameters",
+            endpoint=self.get_product_order_parameters,
+            name=f"{self.root_router.name}:{self.product.id}:get-order-parameters",
+            methods=["GET"],
+            summary="Get order parameters for the product",
+        )
+
         self.add_api_route(
             path="/order",
             endpoint=self.create_order,
@@ -105,8 +113,14 @@ async def get_product_constraints(self: Self) -> JsonSchemaModel:
         """
         return self.product.constraints
 
+    async def get_product_order_parameters(self: Self) -> JsonSchemaModel:
+        """
+        Return supported order parameters of a specific product
+        """
+        return self.product.order_parameters
+
     async def create_order(
-        self, payload: OpportunityRequest, request: Request, response: Response
+        self, payload: OrderRequest, request: Request, response: Response
     ) -> Order:
         """
         Create a new order.

src/stapi_fastapi/routers/root_router.py

@@ -57,7 +57,7 @@ def __init__(
             methods=["GET"],
             name=f"{self.name}:list-orders",
             response_class=GeoJSONResponse,
-            tags=["Order"],
+            tags=["Orders"],
         )
 
         self.add_api_route(

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, OrderCollection
+from stapi_fastapi.models.order import Order, OrderCollection, OrderRequest
 from stapi_fastapi.routers.product_router import ProductRouter
 
 
@@ -35,7 +35,7 @@ async def get_order(self, order_id: str, request: Request) -> Order:
 class MockProductBackend(ProductBackend):
     def __init__(self, orders: MockOrderDB) -> None:
         self._opportunities: list[Opportunity] = []
-        self._allowed_payloads: list[OpportunityRequest] = []
+        self._allowed_payloads: list[OrderRequest] = []
         self._orders = orders
 
     async def search_opportunities(
@@ -49,7 +49,7 @@ async def search_opportunities(
     async def create_order(
         self,
         product_router: ProductRouter,
-        payload: OpportunityRequest,
+        payload: OrderRequest,
         request: Request,
     ) -> Order:
         """
@@ -64,6 +64,7 @@ async def create_order(
                     "filter": payload.filter,
                     "datetime": payload.datetime,
                     "product_id": product_router.product.id,
+                    # **payload.order_parameters,
                 },
                 links=[],
             )