add product order-parameters endpoint and links (#104)

* add product order-parameters endpoint and links

* CHANGELOG

* add links to product and opportunity-collection

* fix mypy warning on unused var

---------

Co-authored-by: Phil Varner <[email protected]>

Author: philvarner

CHANGELOG.md

@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Conformance endpoint `/conformance` and root body `conformsTo` attribute.
+- Endpoint /product/{productId}/order-parameters.
+- Links in Product entity to order-parameters and constraints endpoints for that product.
+- Add links `opportunities` and `create-order` to Product
+- Add link `create-order` to OpportunityCollection
 
 ### Changed
 

bin/server.py

@@ -13,6 +13,7 @@
 )
 from stapi_fastapi.models.order import Order, OrderCollection
 from stapi_fastapi.models.product import (
+    OrderParameters,
     Product,
     Provider,
     ProviderRole,
@@ -82,6 +83,10 @@ class TestSpotlightProperties(OpportunityPropertiesBase):
     off_nadir: int
 
 
+class TestSpotlightOrderParameters(OrderParameters):
+    delivery_mechanism: str | None = None
+
+
 order_db = MockOrderDB()
 product_backend = MockProductBackend(order_db)
 root_backend = MockRootBackend(order_db)
@@ -102,6 +107,7 @@ class TestSpotlightProperties(OpportunityPropertiesBase):
     providers=[provider],
     links=[],
     constraints=TestSpotlightProperties,
+    order_parameters=TestSpotlightOrderParameters,
     backend=product_backend,
 )
 

src/stapi_fastapi/models/product.py

@@ -4,7 +4,7 @@
 from enum import Enum
 from typing import TYPE_CHECKING, Literal, Optional, Self
 
-from pydantic import AnyHttpUrl, BaseModel, Field
+from pydantic import AnyHttpUrl, BaseModel, ConfigDict, Field
 
 from stapi_fastapi.models.opportunity import OpportunityPropertiesBase
 from stapi_fastapi.models.shared import Link
@@ -32,6 +32,10 @@ def __init__(self, url: AnyHttpUrl | str, **kwargs):
         super().__init__(url=url, **kwargs)
 
 
+class OrderParameters(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+
 class Product(BaseModel):
     type_: Literal["Product"] = Field(default="Product", alias="type")
     conformsTo: list[str] = Field(default_factory=list)
@@ -45,18 +49,21 @@ class Product(BaseModel):
 
     # we don't want to include these in the model fields
     _constraints: type[OpportunityPropertiesBase]
+    _order_parameters: type[OrderParameters]
     _backend: ProductBackend
 
     def __init__(
         self,
         *args,
         backend: ProductBackend,
         constraints: type[OpportunityPropertiesBase],
+        order_parameters: type[OrderParameters],
         **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 +73,10 @@ def backend(self: Self) -> ProductBackend:
     def constraints(self: Self) -> type[OpportunityPropertiesBase]:
         return self._constraints
 
+    @property
+    def order_parameters(self: Self) -> type[OrderParameters]:
+        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

@@ -63,6 +63,15 @@ def __init__(
             tags=["Products"],
         )
 
+        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",
+            tags=["Products"],
+        )
+
         self.add_api_route(
             path="/order",
             endpoint=self.create_order,
@@ -86,6 +95,42 @@ def get_product(self, request: Request) -> Product:
                     rel="self",
                     type=TYPE_JSON,
                 ),
+                Link(
+                    href=str(
+                        request.url_for(
+                            f"{self.root_router.name}:{self.product.id}:get-constraints",
+                        ),
+                    ),
+                    rel="constraints",
+                    type=TYPE_JSON,
+                ),
+                Link(
+                    href=str(
+                        request.url_for(
+                            f"{self.root_router.name}:{self.product.id}:get-order-parameters",
+                        ),
+                    ),
+                    rel="order-parameters",
+                    type=TYPE_JSON,
+                ),
+                Link(
+                    href=str(
+                        request.url_for(
+                            f"{self.root_router.name}:{self.product.id}:search-opportunities",
+                        ),
+                    ),
+                    rel="opportunities",
+                    type=TYPE_JSON,
+                ),
+                Link(
+                    href=str(
+                        request.url_for(
+                            f"{self.root_router.name}:{self.product.id}:create-order",
+                        ),
+                    ),
+                    rel="create-order",
+                    type=TYPE_JSON,
+                ),
             ],
         )
 
@@ -102,14 +147,33 @@ async def search_opportunities(
         except ConstraintsException as exc:
             raise HTTPException(status.HTTP_422_UNPROCESSABLE_ENTITY, detail=exc.detail)
 
-        return OpportunityCollection(features=opportunities)
+        return OpportunityCollection(
+            features=opportunities,
+            links=[
+                Link(
+                    href=str(
+                        request.url_for(
+                            f"{self.root_router.name}:{self.product.id}:create-order",
+                        ),
+                    ),
+                    rel="create-order",
+                    type=TYPE_JSON,
+                ),
+            ],
+        )
 
     async def get_product_constraints(self: Self) -> JsonSchemaModel:
         """
         Return supported constraints of a specific product
         """
         return self.product.constraints
 
+    async def get_product_order_parameters(self: Self) -> JsonSchemaModel:
+        """
+        Return supported constraints of a specific product
+        """
+        return self.product.order_parameters
+
     async def create_order(
         self, payload: OpportunityRequest, request: Request, response: Response
     ) -> Order:

tests/conftest.py

@@ -15,7 +15,12 @@
     OpportunityPropertiesBase,
     OpportunityRequest,
 )
-from stapi_fastapi.models.product import Product, Provider, ProviderRole
+from stapi_fastapi.models.product import (
+    OrderParameters,
+    Product,
+    Provider,
+    ProviderRole,
+)
 from stapi_fastapi.routers.root_router import RootRouter
 
 from .backends import MockOrderDB, MockProductBackend, MockRootBackend
@@ -26,6 +31,10 @@ class TestSpotlightProperties(OpportunityPropertiesBase):
     off_nadir: int
 
 
+class TestSpotlightOrderParameters(OrderParameters):
+    delivery_mechanism: str | None = None
+
+
 @pytest.fixture(scope="session")
 def base_url() -> Iterator[str]:
     yield "http://stapiserver"
@@ -60,6 +69,7 @@ def mock_product_test_spotlight(
         providers=[mock_provider],
         links=[],
         constraints=TestSpotlightProperties,
+        order_parameters=TestSpotlightOrderParameters,
         backend=product_backend,
     )
 

tests/opportunity_test.py

@@ -16,6 +16,7 @@ def test_search_opportunities_response(
     mock_test_spotlight_opportunities: List[Opportunity],
     product_backend: MockProductBackend,
     stapi_client: TestClient,
+    assert_link,
 ) -> None:
     product_backend._opportunities = mock_test_spotlight_opportunities
 
@@ -50,9 +51,11 @@ def test_search_opportunities_response(
 
     # Validate response status and structure
     assert response.status_code == 200, f"Failed for product: {product_id}"
-    _json = response.json()
+    body = response.json()
 
     try:
-        OpportunityCollection(**_json)
+        _ = OpportunityCollection(**body)
     except Exception as _:
         pytest.fail("response is not an opportunity collection")
+
+    assert_link(f"POST {url}", body, "create-order", f"/products/{product_id}/order")

tests/product_test.py

@@ -2,8 +2,6 @@
 from fastapi import status
 from fastapi.testclient import TestClient
 
-from .utils import find_link
-
 
 def test_products_response(stapi_client: TestClient):
     res = stapi_client.get("/products")
@@ -21,17 +19,22 @@ def test_products_response(stapi_client: TestClient):
 def test_product_response_self_link(
     product_id: str,
     stapi_client: TestClient,
-    url_for,
+    assert_link,
 ):
     res = stapi_client.get(f"/products/{product_id}")
     assert res.status_code == status.HTTP_200_OK
     assert res.headers["Content-Type"] == "application/json"
 
-    data = res.json()
-    link = find_link(data["links"], "self")
-    assert link, "GET /products Link[rel=self] should exist"
-    assert link["type"] == "application/json"
-    assert link["href"] == url_for(f"/products/{product_id}")
+    body = res.json()
+
+    url = "GET /products"
+    assert_link(url, body, "self", f"/products/{product_id}")
+    assert_link(url, body, "constraints", f"/products/{product_id}/constraints")
+    assert_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")
 
 
 @pytest.mark.parametrize("product_id", ["test-spotlight"])
@@ -43,7 +46,21 @@ def test_product_constraints_response(
     assert res.status_code == status.HTTP_200_OK
     assert res.headers["Content-Type"] == "application/json"
 
-    data = res.json()
-    assert "properties" in data
-    assert "datetime" in data["properties"]
-    assert "off_nadir" in data["properties"]
+    json_schema = res.json()
+    assert "properties" in json_schema
+    assert "datetime" in json_schema["properties"]
+    assert "off_nadir" in json_schema["properties"]
+
+
+@pytest.mark.parametrize("product_id", ["test-spotlight"])
+def test_product_order_parameters_response(
+    product_id: str,
+    stapi_client: TestClient,
+):
+    res = stapi_client.get(f"/products/{product_id}/order-parameters")
+    assert res.status_code == status.HTTP_200_OK
+    assert res.headers["Content-Type"] == "application/json"
+
+    json_schema = res.json()
+    assert "properties" in json_schema
+    assert "delivery_mechanism" in json_schema["properties"]