Merge branch 'main' into pv/root-backend-abstraction

Author: Phil Varner

CHANGELOG.md

@@ -14,6 +14,10 @@ none
 ### Changed
 
 - RootBackend protocol uses `returns` library types Result and Maybe instead of exceptions.
+- Create Order endpoint from `.../order` to `.../orders`
+- Order field `id` must be a string, instead of previously allowing int. This is because while an
+  order ID may an integral numeric value, it is not a "number" in the sense that math will be performed
+  order ID values, so string represents this better.
 
 ### Deprecated
 

src/stapi_fastapi/models/order.py

@@ -8,7 +8,6 @@
     BaseModel,
     ConfigDict,
     Field,
-    StrictInt,
     StrictStr,
 )
 
@@ -75,7 +74,7 @@ class OrderProperties(BaseModel):
 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
+    id: StrictStr
     type: Literal["Feature"] = "Feature"
     links: list[Link] = Field(default_factory=list)
 

src/stapi_fastapi/routers/product_router.py

@@ -91,7 +91,7 @@ async def _create_order(
         ]
 
         self.add_api_route(
-            path="/order",
+            path="/orders",
             endpoint=_create_order,
             name=f"{self.root_router.name}:{self.product.id}:create-order",
             methods=["POST"],

tests/opportunity_test.py

@@ -58,4 +58,4 @@ def test_search_opportunities_response(
     except Exception as _:
         pytest.fail("response is not an opportunity collection")
 
-    assert_link(f"POST {url}", body, "create-order", f"/products/{product_id}/order")
+    assert_link(f"POST {url}", body, "create-order", f"/products/{product_id}/orders")

tests/order_test.py

@@ -44,7 +44,7 @@ def new_order_response(
     product_backend._allowed_payloads = create_order_allowed_payloads
 
     res = stapi_client.post(
-        f"products/{product_id}/order",
+        f"products/{product_id}/orders",
         json=create_order_allowed_payloads[0].model_dump(),
     )
 

tests/product_test.py

@@ -34,7 +34,7 @@ def test_product_response_self_link(
         url, body, "order-parameters", f"/products/{product_id}/order-parameters"
     )
     assert_link(url, body, "opportunities", f"/products/{product_id}/opportunities")
-    assert_link(url, body, "create-order", f"/products/{product_id}/order")
+    assert_link(url, body, "create-order", f"/products/{product_id}/orders")
 
 
 @pytest.mark.parametrize("product_id", ["test-spotlight"])