add links to product and opportunity-collection

Author: Phil Varner

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - 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
 

src/stapi_fastapi/routers/product_router.py

@@ -113,6 +113,24 @@ def get_product(self, request: Request) -> Product:
                     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,
+                ),
             ],
         )
 
@@ -129,7 +147,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,
+                ),
+            ],
+        )
 
     async def get_product_constraints(self: Self) -> JsonSchemaModel:
         """

tests/opportunity_test.py

@@ -3,7 +3,6 @@
 
 import pytest
 from fastapi.testclient import TestClient
-
 from stapi_fastapi.models.opportunity import Opportunity, OpportunityCollection
 
 from .backends import MockProductBackend
@@ -16,6 +15,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 +50,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)
+        oc = 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

@@ -33,6 +33,12 @@ def test_product_response_self_link(
     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"])