add query to item collection

Author: jonhealy1

stac_fastapi/core/stac_fastapi/core/core.py

@@ -289,6 +289,7 @@ async def item_collection(
         limit: Optional[int] = None,
         sortby: Optional[str] = None,
         token: Optional[str] = None,
+        query: Optional[str] = None,
         **kwargs,
     ) -> stac_types.ItemCollection:
         """List items within a specific collection.
@@ -306,6 +307,7 @@ async def item_collection(
                 like ``sortby=-properties.datetime`` or ``sortby=+id``. Bare fields (e.g. ``sortby=id``)
                 imply ascending order.
             token (Optional[str]): Optional pagination token.
+            query (Optional[str]): Optional query string.
             **kwargs: Must include ``request`` (FastAPI Request).
 
         Returns:
@@ -330,6 +332,7 @@ async def item_collection(
             limit=limit,
             token=token,
             sortby=sortby,
+            query=query,
         )
 
     async def get_item(

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py

@@ -44,6 +44,7 @@
     TransactionExtension,
 )
 from stac_fastapi.extensions.core.filter import FilterConformanceClasses
+from stac_fastapi.extensions.core.query import QueryConformanceClasses
 from stac_fastapi.extensions.core.sort import SortConformanceClasses
 from stac_fastapi.extensions.third_party import BulkTransactionExtension
 from stac_fastapi.sfeos_helpers.aggregation import EsAsyncBaseAggregationClient
@@ -127,7 +128,10 @@
     extensions=[
         SortExtension(
             conformance_classes=[SortConformanceClasses.ITEMS],
-        )
+        ),
+        QueryExtension(
+            conformance_classes=[QueryConformanceClasses.ITEMS],
+        ),
     ],
     request_type="GET",
 )

stac_fastapi/opensearch/stac_fastapi/opensearch/app.py

@@ -38,6 +38,7 @@
     TransactionExtension,
 )
 from stac_fastapi.extensions.core.filter import FilterConformanceClasses
+from stac_fastapi.extensions.core.query import QueryConformanceClasses
 from stac_fastapi.extensions.core.sort import SortConformanceClasses
 from stac_fastapi.extensions.third_party import BulkTransactionExtension
 from stac_fastapi.opensearch.config import OpensearchSettings
@@ -127,7 +128,10 @@
     extensions=[
         SortExtension(
             conformance_classes=[SortConformanceClasses.ITEMS],
-        )
+        ),
+        QueryExtension(
+            conformance_classes=[QueryConformanceClasses.ITEMS],
+        ),
     ],
     request_type="GET",
 )

stac_fastapi/tests/api/test_api.py

@@ -1606,3 +1606,31 @@ async def test_collection_items_sort_asc(app_client, txn_client, ctx):
     resp_json = resp.json()
     assert resp_json["features"][0]["id"] == second_item["id"]
     assert resp_json["features"][1]["id"] == first_item["id"]
+
+
+@pytest.mark.asyncio
+async def test_item_collection_query(app_client, txn_client, ctx):
+    """Simple query parameter test on the Item Collection route.
+
+    Creates an item with a unique property and ensures it can be retrieved
+    using the 'query' parameter on GET /collections/{collection_id}/items.
+    """
+    unique_val = str(uuid.uuid4())
+    test_item = deepcopy(ctx.item)
+    test_item["id"] = f"query-basic-{unique_val}"
+    # Add a property to filter on
+    test_item.setdefault("properties", {})["test_query_key"] = unique_val
+
+    await create_item(txn_client, test_item)
+
+    # Provide the query parameter as a JSON string without adding new imports
+    query_param = f'{{"test_query_key": {{"eq": "{unique_val}"}}}}'
+
+    resp = await app_client.get(
+        f"/collections/{test_item['collection']}/items",
+        params=[("query", query_param)],
+    )
+    assert resp.status_code == 200
+    resp_json = resp.json()
+    ids = [f["id"] for f in resp_json["features"]]
+    assert test_item["id"] in ids