change Order order_parameters to dict, OrderRequest to typed object

Author: Phil Varner

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
       - id: trailing-whitespace
       - id: no-commit-to-branch
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.7.3
+    rev: v0.7.4
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

bin/server.py

@@ -1,3 +1,4 @@
+from datetime import datetime, timezone
 from uuid import uuid4
 
 from fastapi import FastAPI, Request
@@ -16,6 +17,8 @@
     OrderCollection,
     OrderParameters,
     OrderRequest,
+    OrderStatus,
+    OrderStatusCode,
 )
 from stapi_fastapi.models.product import (
     Product,
@@ -75,10 +78,17 @@ async def create_order(
             geometry=payload.geometry,
             properties={
                 "product_id": product_router.product.id,
-                "datetime": payload.datetime,
-                "geometry": payload.geometry,
-                "filter": payload.filter,
-                "order_parameters": payload.order_parameters,
+                "created": datetime.now(timezone.utc),
+                "status": OrderStatus(
+                    timestamp=datetime.now(timezone.utc),
+                    status_code=OrderStatusCode.accepted,
+                ),
+                "search_parameters": {
+                    "geometry": payload.geometry,
+                    "datetime": payload.datetime,
+                    "filter": payload.filter,
+                },
+                "order_parameters": payload.order_parameters.model_dump(),
                 "opportunity_properties": {
                     "datetime": "2024-01-29T12:00:00Z/2024-01-30T12:00:00Z",
                     "off_nadir": 10,

poetry.lock

@@ -15,13 +15,14 @@ pydantic = "^2.9.2"
 geojson-pydantic = "^1.1.1"
 pygeofilter = "^0.2.4"
 cql2 = "^0.3.1"
+ruff = "^0.7.4"
 
 [tool.poetry.group.dev]
 optional = true
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.1.1"
-ruff = "^0.3.4"
+ruff = "^0.7.4"
 uvicorn = "^0.29.0"
 pydantic-settings = "^2.2.1"
 httpx = "^0.27.0"

pyproject.toml

@@ -1,8 +1,16 @@
-from typing import Any, Generic, Literal, TypeVar
+from enum import Enum
+from typing import Any, Generic, Literal, Optional, TypeVar
 
 from geojson_pydantic import Feature, FeatureCollection
 from geojson_pydantic.geometries import Geometry
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from pydantic import (
+    AwareDatetime,
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictInt,
+    StrictStr,
+)
 
 from stapi_fastapi.models.opportunity import OpportunityProperties
 from stapi_fastapi.models.shared import Link
@@ -24,19 +32,42 @@ class OrderRequest(BaseModel, Generic[ORP]):
     # TODO: validate the CQL2 filter?
     filter: CQL2Filter | None = None
 
-    order_parameters: dict[str, Any]
+    order_parameters: ORP
 
     model_config = ConfigDict(strict=True)
 
 
-class OrderProperties(BaseModel, Generic[OPP, ORP]):
-    product_id: str
+class OrderStatusCode(str, Enum):
+    received = "received"
+    accepted = "accepted"
+    rejected = "rejected"
+    completed = "completed"
+    canceled = "canceled"
+
+
+class OrderStatus(BaseModel):
+    timestamp: AwareDatetime
+    status_code: OrderStatusCode
+    reason_code: Optional[str] = None
+    reason_text: Optional[str] = None
+    links: list[Link] = Field(default_factory=list)
+
+
+class OrderSearchParameters(BaseModel):
     datetime: DatetimeInterval
+    geometry: Geometry
     # TODO: validate the CQL2 filter?
     filter: CQL2Filter | None = None
 
-    opportunity_properties: OPP
-    order_parameters: ORP
+
+class OrderProperties(BaseModel, Generic[OPP, ORP]):
+    product_id: str
+    created: AwareDatetime
+    status: OrderStatus
+
+    search_parameters: OrderSearchParameters
+    opportunity_properties: dict[str, Any]
+    order_parameters: dict[str, Any]
 
     model_config = ConfigDict(extra="allow")
 

src/stapi_fastapi/models/order.py

@@ -1,3 +1,4 @@
+from datetime import datetime, timezone
 from uuid import uuid4
 
 from fastapi import Request
@@ -6,7 +7,13 @@
 from stapi_fastapi.backends.root_backend import RootBackend
 from stapi_fastapi.exceptions import ConstraintsException, NotFoundException
 from stapi_fastapi.models.opportunity import Opportunity, OpportunityRequest
-from stapi_fastapi.models.order import Order, OrderCollection, OrderRequest
+from stapi_fastapi.models.order import (
+    Order,
+    OrderCollection,
+    OrderRequest,
+    OrderStatus,
+    OrderStatusCode,
+)
 from stapi_fastapi.routers.product_router import ProductRouter
 
 from .shared import SpotlightOpportunityProperties, SpotlightOrderParameters
@@ -60,15 +67,24 @@ async def create_order(
         Create a new order.
         """
         if any(allowed == payload for allowed in self._allowed_payloads):
-            order = Order[SpotlightOpportunityProperties, SpotlightOrderParameters](
+            order = Order[
+                SpotlightOpportunityProperties, SpotlightOrderParameters
+            ](
                 id=str(uuid4()),
-                geometry=payload.geometry,
+                geometry=payload.geometry,  # maybe set to a different value by opportunity resolution process
                 properties={
                     "product_id": product_router.product.id,
-                    "datetime": payload.datetime,
-                    "geometry": payload.geometry,
-                    "filter": payload.filter,
-                    "order_parameters": payload.order_parameters,
+                    "created": datetime.now(timezone.utc),
+                    "status": OrderStatus(
+                        timestamp=datetime.now(timezone.utc),
+                        status_code=OrderStatusCode.accepted,
+                    ),
+                    "search_parameters": {
+                        "geometry": payload.geometry,
+                        "datetime": payload.datetime,
+                        "filter": payload.filter,
+                    },
+                    "order_parameters": payload.order_parameters.model_dump(),
                     "opportunity_properties": {
                         "datetime": "2024-01-29T12:00:00Z/2024-01-30T12:00:00Z",
                         "off_nadir": 10,

tests/backends.py

@@ -10,7 +10,7 @@
 from stapi_fastapi.models.order import OrderRequest
 
 from .backends import MockProductBackend
-from .shared import find_link
+from .shared import SpotlightOrderParameters, find_link
 
 NOW = datetime.now(UTC)
 START = NOW
@@ -29,7 +29,7 @@ def create_order_allowed_payloads() -> list[OrderRequest]:
                 datetime.fromisoformat("2024-11-15T18:55:33Z"),
             ),
             filter=None,
-            order_parameters={"s3_path": "BUCKET"},
+            order_parameters=SpotlightOrderParameters(s3_path="s3://my-bucket"),
         ),
     ]
 
@@ -86,7 +86,12 @@ def test_get_order_properties(
         "coordinates": list(create_order_allowed_payloads[0].geometry.coordinates),
     }
 
+    assert order["properties"]["search_parameters"]["geometry"] == {
+        "type": "Point",
+        "coordinates": list(create_order_allowed_payloads[0].geometry.coordinates),
+    }
+
     assert (
-        order["properties"]["datetime"]
+        order["properties"]["search_parameters"]["datetime"]
         == create_order_allowed_payloads[0].model_dump()["datetime"]
     )