Merge branch 'main' into 87_order_parameters

Author: Phil Varner

CHANGELOG.md

@@ -5,11 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [v0.1.0] - TBD
+
+Initial release
 
 ### Added
 
 - Conformance endpoint `/conformance` and root body `conformsTo` attribute.
+- Field `product_id` to Opportunity and Order Properties
+- 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
 
@@ -31,9 +38,6 @@ none
 
 none
 
-## [v0.1.0] - 2024-10-23
-
-Initial release
 
 [unreleased]: https://github.com/stapi-spec/stapi-fastapi/compare/v0.1.0...main
 [v0.1.0]: https://github.com/stapi-spec/stapi-fastapi/tree/v0.1.0

bin/server.py

@@ -96,7 +96,7 @@ class MyOpportunityProperties(OpportunityProperties):
 
 
 class MyOrderParameters(OrderParameters):
-    s3_path: str
+    delivery_mechanism: str | None = None
 
 
 order_db = MockOrderDB()

src/stapi_fastapi/models/opportunity.py

@@ -11,6 +11,7 @@
 
 # Copied and modified from https://github.com/stac-utils/stac-pydantic/blob/main/stac_pydantic/item.py#L11
 class OpportunityProperties(BaseModel):
+    product_id: str
     datetime: DatetimeInterval
     model_config = ConfigDict(extra="allow")
 

src/stapi_fastapi/routers/product_router.py

@@ -69,6 +69,7 @@ def __init__(
             name=f"{self.root_router.name}:{self.product.id}:get-order-parameters",
             methods=["GET"],
             summary="Get order parameters for the product",
+            tags=["Products"],
         )
 
         # This wraps `self.create_order` to explicitly parameterize `OrderRequest`
@@ -118,6 +119,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,
+                ),
             ],
         )
 
@@ -134,7 +171,20 @@ 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,
+                ),
+            ],
+        )
 
     def get_product_constraints(self: Self) -> JsonSchemaModel:
         """
@@ -144,7 +194,7 @@ def get_product_constraints(self: Self) -> JsonSchemaModel:
 
     def get_product_order_parameters(self: Self) -> JsonSchemaModel:
         """
-        Return supported order parameters of a specific product
+        Return supported constraints of a specific product
         """
         return self.product.order_parameters
 

tests/conftest.py

@@ -13,13 +13,22 @@
 from stapi_fastapi.models.opportunity import (
     Opportunity,
 )
-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
 from .shared import SpotlightOpportunityProperties, SpotlightOrderParameters, find_link
 
 
+class TestSpotlightOrderParameters(OrderParameters):
+    delivery_mechanism: str | None = None
+
+
 @pytest.fixture(scope="session")
 def base_url() -> Iterator[str]:
     yield "http://stapiserver"
@@ -132,6 +141,7 @@ def mock_test_spotlight_opportunities() -> list[Opportunity]:
                 coordinates=Position2D(longitude=0.0, latitude=0.0),
             ),
             properties=SpotlightOpportunityProperties(
+                product_id="xyz123",
                 datetime=(start, end),
                 off_nadir=20,
             ),

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 .shared 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"]