Add support for sub-catalog behaviors

Author: moradology

stac_fastapi/api/stac_fastapi/api/app.py

@@ -81,9 +81,15 @@ class StacApi:
     api_version: str = attr.ib(default="0.1")
     stac_version: str = attr.ib(default=STAC_VERSION)
     description: str = attr.ib(default="stac-fastapi")
+    search_get_request_base_model: Type[BaseSearchGetRequest] = attr.ib(
+        default=BaseSearchGetRequest
+    )
     search_get_request_model: Type[BaseSearchGetRequest] = attr.ib(
         default=BaseSearchGetRequest
     )
+    search_post_request_base_model: Type[BaseSearchPostRequest] = attr.ib(
+        default=BaseSearchPostRequest
+    )
     search_post_request_model: Type[BaseSearchPostRequest] = attr.ib(
         default=BaseSearchPostRequest
     )
@@ -263,25 +269,6 @@ def register_get_collection(self):
             ),
         )
 
-    def register_get_catalog(self):
-        """Register get collection endpoint (GET /catalog/{catalog_path}).
-
-        Returns:
-            None
-        """
-        self.router.add_api_route(
-            name="Get Catalog",
-            path="/catalogs/{catalog_path:path}",
-            response_model=Catalog if self.settings.enable_response_models else None,
-            response_class=self.response_class,
-            response_model_exclude_unset=True,
-            response_model_exclude_none=True,
-            methods=["GET"],
-            endpoint=self._create_endpoint(
-                self.client.get_catalog, CatalogUri, self.response_class
-            ),
-        )
-
     def register_get_root_children(self):
         """Register get collection children endpoint (GET /collection/{collection_id}/children).
 
@@ -328,6 +315,119 @@ def register_get_item_collection(self):
             ),
         )
 
+    def register_catalog_conformance_classes(self):
+        """Register catalog conformance class endpoint (GET /catalogs/{catalog_path}/conformance).
+
+        Returns:
+            None
+        """
+        self.router.add_api_route(
+            name="Conformance Classes",
+            path="/catalogs/{catalog_path:path}/conformance",
+            response_model=ConformanceClasses
+            if self.settings.enable_response_models
+            else None,
+            response_class=self.response_class,
+            response_model_exclude_unset=True,
+            response_model_exclude_none=True,
+            methods=["GET"],
+            endpoint=self._create_endpoint(
+                self.client.conformance, EmptyRequest, self.response_class
+            ),
+        )
+
+    def register_post_catalog_search(self):
+        """Register search endpoint (POST /search).
+
+        Returns:
+            None
+        """
+        fields_ext = self.get_extension(FieldsExtension)
+        self.router.add_api_route(
+            name="Search",
+            path="/catalogs/{catalog_path:path}/search",
+            response_model=(ItemCollection if not fields_ext else None)
+            if self.settings.enable_response_models
+            else None,
+            response_class=GeoJSONResponse,
+            response_model_exclude_unset=True,
+            response_model_exclude_none=True,
+            methods=["POST"],
+            endpoint=self._create_endpoint(
+                self.client.post_catalog_search,
+                self.search_post_request_model,
+                GeoJSONResponse,
+            ),
+        )
+
+    def register_get_catalog_search(self):
+        """Register catalog search endpoint (GET /catalogs/{catalog_path}/search).
+
+        Returns:
+            None
+        """
+        fields_ext = self.get_extension(FieldsExtension)
+        request_model = create_request_model(
+            "GetSearchWithCatalogUri",
+            base_model=self.search_get_request_base_model,
+            extensions=self.extensions,
+            mixins=[CatalogUri],
+        )
+        self.router.add_api_route(
+            name="Catalog Search",
+            path="/catalogs/{catalog_path:path}/search",
+            response_model=(ItemCollection if not fields_ext else None)
+            if self.settings.enable_response_models
+            else None,
+            response_class=GeoJSONResponse,
+            response_model_exclude_unset=True,
+            response_model_exclude_none=True,
+            methods=["GET"],
+            endpoint=self._create_endpoint(
+                self.client.get_catalog_search, request_model, GeoJSONResponse
+            ),
+        )
+
+    def register_get_catalog_collections(self):
+        """Register get collections endpoint (GET /collections).
+
+        Returns:
+            None
+        """
+        self.router.add_api_route(
+            name="Get Collections",
+            path="/catalogs/{catalog_path:path}/collections",
+            response_model=Collections
+            if self.settings.enable_response_models
+            else None,
+            response_class=self.response_class,
+            response_model_exclude_unset=True,
+            response_model_exclude_none=True,
+            methods=["GET"],
+            endpoint=self._create_endpoint(
+                self.client.get_catalog_collections, CatalogUri, self.response_class
+            ),
+        )
+
+    def register_get_catalog(self):
+        """Register get collection endpoint (GET /catalog/{catalog_path}).
+
+        Returns:
+            None
+        """
+        self.router.add_api_route(
+            name="Get Catalog",
+            path="/catalogs/{catalog_path:path}",
+            response_model=Catalog if self.settings.enable_response_models else None,
+            response_class=self.response_class,
+            response_model_exclude_unset=True,
+            response_model_exclude_none=True,
+            methods=["GET"],
+            endpoint=self._create_endpoint(
+                self.client.get_catalog, CatalogUri, self.response_class
+            ),
+        )
+
     def register_core(self):
         """Register core STAC endpoints.
 
@@ -352,9 +452,14 @@ def register_core(self):
         self.register_get_search()
         self.register_get_collections()
         self.register_get_collection()
-        self.register_get_catalog()
         self.register_get_item_collection()
 
+        # Browseable endpoints
+        self.register_catalog_conformance_classes()
+        self.register_post_catalog_search()
+        self.register_get_catalog_search()
+        self.register_get_catalog_collections()
+        self.register_get_catalog()
         if self.settings.browseable_hierarchy_definition is not None:
             self.register_get_root_children()
 

stac_fastapi/api/stac_fastapi/api/models.py

@@ -1,7 +1,7 @@
 """api request/response models."""
 
 import importlib.util
-from typing import Optional, Type, Union
+from typing import List, Optional, Type, Union
 
 import attr
 from fastapi import Body, Path
@@ -19,8 +19,8 @@
 def create_request_model(
     model_name="SearchGetRequest",
     base_model: Union[Type[BaseModel], APIRequest] = BaseSearchGetRequest,
-    extensions: Optional[ApiExtension] = None,
-    mixins: Optional[Union[BaseModel, APIRequest]] = None,
+    extensions: Optional[List[ApiExtension]] = None,
+    mixins: Optional[List[Union[BaseModel, APIRequest]]] = None,
     request_type: Optional[str] = "GET",
 ) -> Union[Type[BaseModel], APIRequest]:
     """Create a pydantic model for validating request bodies."""
@@ -74,25 +74,27 @@ def create_request_model(
 
 
 def create_get_request_model(
-    extensions, base_model: BaseSearchGetRequest = BaseSearchGetRequest
+    extensions, base_model: BaseSearchGetRequest = BaseSearchGetRequest, mixins=None
 ):
     """Wrap create_request_model to create the GET request model."""
     return create_request_model(
         "SearchGetRequest",
         base_model=base_model,
         extensions=extensions,
+        mixins=mixins,
         request_type="GET",
     )
 
 
 def create_post_request_model(
-    extensions, base_model: BaseSearchPostRequest = BaseSearchPostRequest
+    extensions, base_model: BaseSearchPostRequest = BaseSearchPostRequest, mixins=None
 ):
     """Wrap create_request_model to create the POST request model."""
     return create_request_model(
         "SearchPostRequest",
         base_model=base_model,
         extensions=extensions,
+        mixins=mixins,
         request_type="POST",
     )
 

stac_fastapi/pgstac/stac_fastapi/pgstac/app.py

@@ -47,6 +47,7 @@
     ),
     response_class=ORJSONResponse,
     search_get_request_model=create_get_request_model(extensions),
+    search_post_request_base_model=PgstacSearch,
     search_post_request_model=post_request_model,
 )
 app = api.app