feat: changed so /opportunities no longer can accept query params and next/limit must be passed as key/value pairs in the POST body. These are also now returned in the POST body in the 'next' link object returned by /opportunities tests: update tests to reflect changes in endpoint. POST body is now extracted wholesale from returned link object istead of just the params

Author: theodorehreuter

src/stapi_fastapi/routers/product_router.py

@@ -2,9 +2,9 @@
 
 import logging
 import traceback
-from typing import TYPE_CHECKING, Self
+from typing import TYPE_CHECKING, Annotated, Self
 
-from fastapi import APIRouter, HTTPException, Request, Response, status
+from fastapi import APIRouter, Body, HTTPException, Request, Response, status
 from geojson_pydantic.geometries import Geometry
 from returns.maybe import Some
 from returns.result import Failure, Success
@@ -165,8 +165,8 @@ async def search_opportunities(
         self,
         search: OpportunityRequest,
         request: Request,
-        next: str | None = None,
-        limit: int = 10,
+        next: Annotated[str | None, Body()] = None,
+        limit: Annotated[int, Body()] = 10,
     ) -> OpportunityCollection:
         """
         Explore the opportunities available for a particular set of constraints
@@ -177,8 +177,11 @@ async def search_opportunities(
         ):
             case Success((features, Some(pagination_token))):
                 links.append(self.order_link(request))
-                body = search.model_dump(mode="json")
-                body["next"] = pagination_token
+                body = {
+                    "search": search.model_dump(mode="json"),
+                    "next": pagination_token,
+                    "limit": limit,
+                }
                 links.append(self.pagination_link(request, body))
             case Success((features, Nothing)):  # noqa: F841
                 links.append(self.order_link(request))

tests/conftest.py

@@ -177,8 +177,8 @@ def pagination_tester(
     while next_url:
         url = next_url
         if method == "POST":
-            next_url = next(
-                (d["body"]["next"] for d in resp_body["links"] if d["rel"] == "next"),
+            body = next(
+                (d["body"] for d in resp_body["links"] if d["rel"] == "next"), None
             )
 
         res = make_request(stapi_client, url, method, body, next_url, limit)
@@ -192,10 +192,6 @@ def pagination_tester(
             next_url = next(
                 (d["href"] for d in resp_body["links"] if d["rel"] == "next"), None
             )
-            body = next(
-                (d.get("body") for d in resp_body["links"] if d.get("body")),
-                None,
-            )
         else:
             next_url = None
 
@@ -221,6 +217,6 @@ def make_request(
     if method == "GET":
         res = stapi_client.get(endpoint, params=params)
     if method == "POST":
-        res = stapi_client.post(endpoint, json=body, params=params)
+        res = stapi_client.post(endpoint, json=body)
 
     return res

tests/test_opportunity.py

@@ -7,7 +7,10 @@
 from geojson_pydantic import Point
 from geojson_pydantic.types import Position2D
 
-from stapi_fastapi.models.opportunity import Opportunity, OpportunityCollection
+from stapi_fastapi.models.opportunity import (
+    Opportunity,
+    OpportunityCollection,
+)
 from tests.application import MyOpportunityProperties
 from tests.conftest import pagination_tester
 
@@ -65,18 +68,21 @@ def test_search_opportunities_response(
     end_string = rfc3339_strftime(end, format)
 
     request_payload = {
-        "geometry": {
-            "type": "Point",
-            "coordinates": [0, 0],
-        },
-        "datetime": f"{start_string}/{end_string}",
-        "filter": {
-            "op": "and",
-            "args": [
-                {"op": ">", "args": [{"property": "off_nadir"}, 0]},
-                {"op": "<", "args": [{"property": "off_nadir"}, 45]},
-            ],
+        "search": {
+            "geometry": {
+                "type": "Point",
+                "coordinates": [0, 0],
+            },
+            "datetime": f"{start_string}/{end_string}",
+            "filter": {
+                "op": "and",
+                "args": [
+                    {"op": ">", "args": [{"property": "off_nadir"}, 0]},
+                    {"op": "<", "args": [{"property": "off_nadir"}, 45]},
+                ],
+            },
         },
+        "limit": 10,
     }
 
     url = f"/products/{product_id}/opportunities"
@@ -117,18 +123,21 @@ def test_search_opportunities_pagination(
     end_string = rfc3339_strftime(end, format)
 
     request_payload = {
-        "geometry": {
-            "type": "Point",
-            "coordinates": [0, 0],
-        },
-        "datetime": f"{start_string}/{end_string}",
-        "filter": {
-            "op": "and",
-            "args": [
-                {"op": ">", "args": [{"property": "off_nadir"}, 0]},
-                {"op": "<", "args": [{"property": "off_nadir"}, 45]},
-            ],
+        "search": {
+            "geometry": {
+                "type": "Point",
+                "coordinates": [0, 0],
+            },
+            "datetime": f"{start_string}/{end_string}",
+            "filter": {
+                "op": "and",
+                "args": [
+                    {"op": ">", "args": [{"property": "off_nadir"}, 0]},
+                    {"op": "<", "args": [{"property": "off_nadir"}, 45]},
+                ],
+            },
         },
+        "limit": limit,
     }
 
     pagination_tester(