add free-text search extension

Author: hrodmn

stac_fastapi/pgstac/app.py

@@ -21,6 +21,7 @@
 from stac_fastapi.extensions.core import (
     FieldsExtension,
     FilterExtension,
+    FreeTextExtension,
     SortExtension,
     TokenPaginationExtension,
     TransactionExtension,
@@ -49,6 +50,7 @@
     "fields": FieldsExtension(),
     "pagination": TokenPaginationExtension(),
     "filter": FilterExtension(client=FiltersClient()),
+    "free_text": FreeTextExtension(),
     "bulk_transactions": BulkTransactionExtension(client=BulkTransactionsClient()),
 }
 
@@ -58,6 +60,7 @@
     "sort": SortExtension(),
     "fields": FieldsExtension(),
     "filter": FilterExtension(client=FiltersClient()),
+    "free_text": FreeTextExtension(),
 }
 
 enabled_extensions = (

stac_fastapi/pgstac/core.py

@@ -52,6 +52,7 @@ async def all_collections(  # noqa: C901
         sortby: Optional[str] = None,
         filter: Optional[str] = None,
         filter_lang: Optional[str] = None,
+        q: Optional[List[str]] = None,
         **kwargs,
     ) -> Collections:
         """Cross catalog search (GET).
@@ -79,6 +80,7 @@ async def all_collections(  # noqa: C901
             sortby=sortby,
             filter_query=filter,
             filter_lang=filter_lang,
+            q=q,
         )
 
         async with request.app.state.get_connection(request, "r") as conn:
@@ -451,6 +453,7 @@ async def get_search(
         sortby: Optional[str] = None,
         filter: Optional[str] = None,
         filter_lang: Optional[str] = None,
+        q: Optional[List[str]] = None,
         **kwargs,
     ) -> ItemCollection:
         """Cross catalog search (GET).
@@ -478,6 +481,7 @@ async def get_search(
             sortby=sortby,
             filter_query=filter,
             filter_lang=filter_lang,
+            q=q,
         )
 
         # Do the request
@@ -499,6 +503,7 @@ def clean_search_args(  # noqa: C901
     sortby: Optional[str] = None,
     filter_query: Optional[str] = None,
     filter_lang: Optional[str] = None,
+    q: Optional[List[str]] = None,
 ) -> Dict[str, Any]:
     """Clean up search arguments to match format expected by pgstac"""
     if filter_query:
@@ -541,6 +546,9 @@ def clean_search_args(  # noqa: C901
                 includes.add(field)
         base_args["fields"] = {"include": includes, "exclude": excludes}
 
+    if q:
+        base_args["q"] = " OR ".join(q)
+
     # Remove None values from dict
     clean = {}
     for k, v in base_args.items():

tests/resources/test_collection.py

@@ -303,3 +303,11 @@ async def test_get_collections_search(
         "/collections",
     )
     assert len(resp.json()["collections"]) == 2
+
+    # free-text
+    resp = await app_client.get(
+        "/collections",
+        params={"q": "temperature"},
+    )
+    assert len(resp.json()["collections"]) == 1
+    assert resp.json()["collections"][0]["id"] == load_test2_collection.id