feat: moar extensions (#24)

* --wip-- [skip ci]

* feat: fields

* feat: add sortby

* feat: advertise extensions

* refactor: constant

Author: gadomski

src/stac_fastapi/geoparquet/api.py

@@ -11,29 +11,29 @@
 
 import stac_fastapi.api.models
 from stac_fastapi.api.app import StacApi
+from stac_fastapi.extensions.core.fields import FieldsExtension
 from stac_fastapi.extensions.core.filter import SearchFilterExtension
 from stac_fastapi.extensions.core.pagination import OffsetPaginationExtension
+from stac_fastapi.extensions.core.sort import SortExtension
 from stac_fastapi.types.search import BaseSearchPostRequest
 
 from .client import Client
 from .search import FixedSearchGetRequest
 from .settings import Settings
 
 GEOPARQUET_MEDIA_TYPE = "application/vnd.apache.parquet"
-
-GetSearchRequestModel = stac_fastapi.api.models.create_request_model(
-    model_name="SearchGetRequest",
-    base_model=FixedSearchGetRequest,
-    extensions=[SearchFilterExtension()],
-    mixins=[OffsetPaginationExtension().GET],
-    request_type="GET",
+EXTENSIONS = [
+    OffsetPaginationExtension(),
+    SearchFilterExtension(),
+    FieldsExtension(),
+    SortExtension(),
+]
+
+GetSearchRequestModel = stac_fastapi.api.models.create_get_request_model(
+    base_model=FixedSearchGetRequest, extensions=EXTENSIONS
 )
-PostSearchRequestModel = stac_fastapi.api.models.create_request_model(
-    model_name="SearchPostRequest",
-    base_model=BaseSearchPostRequest,
-    extensions=[SearchFilterExtension()],
-    mixins=[OffsetPaginationExtension().POST],
-    request_type="POST",
+PostSearchRequestModel = stac_fastapi.api.models.create_post_request_model(
+    base_model=BaseSearchPostRequest, extensions=EXTENSIONS
 )
 
 
@@ -135,6 +135,7 @@ def create(
         ),
         search_get_request_model=GetSearchRequestModel,
         search_post_request_model=PostSearchRequestModel,
+        extensions=EXTENSIONS,
     )
     return api
 

src/stac_fastapi/geoparquet/client.py

@@ -165,13 +165,38 @@ def search(
             collections = list(hrefs.keys())
 
         search_dict = search.model_dump(exclude_none=True, by_alias=True)
-        kwargs.pop("filter_crs", None)
-        if filter_expr := kwargs.pop("filter_expr", None):
-            kwargs["filter"] = filter_expr
-        if "filter" not in kwargs:
-            kwargs.pop("filter_lang", None)
         search_dict.update(**kwargs)
 
+        search_dict.pop("filter_crs", None)
+        if filter_expr := search_dict.pop("filter_expr", None):
+            search_dict["filter"] = filter_expr
+        if filter_lang := search_dict.pop("filter_lang", None):
+            search_dict["filter-lang"] = filter_lang
+        if "filter" not in search_dict:
+            search_dict.pop("filter_lang", None)
+            search_dict.pop("filter-lang", None)
+        if fields := search_dict.pop("fields", None):
+            if isinstance(fields, list):
+                include = []
+                exclude = []
+                for field in fields:
+                    if field.startswith("-"):
+                        exclude.append(field)
+                    else:
+                        include.append(field)
+                search_dict.update({"include": include, "exclude": exclude})
+            elif isinstance(fields, dict):
+                search_dict.update(
+                    {
+                        "include": list(fields.get("include", [])),
+                        "exclude": list(fields.get("exclude", [])),
+                    }
+                )
+            else:
+                raise HTTPException(400, f"unexpected fields type: {fields}")
+        if sortby := search_dict.pop("sortby", None):
+            search_dict["sortby"] = sortby
+
         limit = search_dict.get("limit", DEFAULT_LIMIT)
         offset = search_dict.get("offset", 0) or 0
         items: list[dict[str, Any]] = []

tests/test_search.py

@@ -123,8 +123,45 @@ def test_paging_filter(client: TestClient) -> None:
         "offset": ["1"],
         "collections": ["naip,naip-10,openaerialmap-10,openaerialmap"],
         "filter": ["naip:year='2022'"],
-        "filter_lang": ["cql2-text"],
+        "filter-lang": ["cql2-text"],
     }
     response = client.get("/search", params=url.query)
     assert response.status_code == 200
     assert response.json()["features"][0]["id"] == "ne_m_4110263_sw_13_060_20220820"
+
+
+def test_fields_get(client: TestClient) -> None:
+    response = client.get(
+        "/search", params={"collections": "naip", "limit": "1", "fields": "id,geometry"}
+    )
+    response.raise_for_status()
+    data = response.json()
+    assert "properties" not in data["features"][0]
+
+
+def test_fields_post(client: TestClient) -> None:
+    response = client.post(
+        "/search",
+        json={
+            "collections": ["naip"],
+            "limit": "1",
+            "fields": {"include": ["id", "geometry"]},
+        },
+    )
+    response.raise_for_status()
+    data = response.json()
+    assert "properties" not in data["features"][0]
+
+
+def test_sort_get(client: TestClient) -> None:
+    response = client.get("/search", params={"limit": "1", "sortby": "datetime"})
+    response.raise_for_status()
+
+
+def test_sort_post(client: TestClient) -> None:
+    response = client.post(
+        "/search",
+        json={"limit": "1", "sortby": [{"field": "datetime", "direction": "asc"}]},
+    )
+    print(response.json())
+    response.raise_for_status()