Enable collection search extension

[anayeaye]

What

Stac-fastapi-pgstac > v4 supports collection search. Enable collection-search with the free-text extension for the stac-api to support scoping multi-tenant queries.

Objective

https://github.com/NASA-IMPACT/veda-architecture/issues/630

AC

• collection-search supported in stac-api with free-text extension

[anayeaye]

@hrodmn - do you have any tips/pointers for enabling collection-search. I did a quick once over the docs but missed any examples of enabling collection-search. Thanks!

[hrodmn]

The most useful example for the work you will need to do in veda-backend is stac-fastapi-pgstac's app.py. The steps are roughly:

1. upgrade to stac-fastapi-pgstac>=4.0.0
2. pass the list of other enabled extensions to CollectionSearchExtension when you instantiate it
   • this generates the correct GET request model for the /collections endpoint

       cs_extensions_map = {
           "query": QueryExtension(conformance_classes=[QueryConformanceClasses.COLLECTIONS]),
           "sort": SortExtension(conformance_classes=[SortConformanceClasses.COLLECTIONS]),
           "fields": FieldsExtension(conformance_classes=[FieldsConformanceClasses.COLLECTIONS]),
           "filter": CollectionSearchFilterExtension(client=FiltersClient()),
           "free_text": FreeTextExtension(
               conformance_classes=[FreeTextConformanceClasses.COLLECTIONS],
           ),
           "pagination": OffsetPaginationExtension(),
       }
   
       cs_extensions = []
       collection_search_extension = CollectionSearchExtension.from_extensions(cs_extensions.values())
       collections_get_request_model = collection_search_extension.GET

3. Make sure collection_search_extension is included in the list of extensions that are enabled and pass collections_get_request_model to StacApi when you create it:

api = StacApi(
    app=FastAPI(
        ....
    ),
    extensions=[collection_search_extension, ...],
    collections_get_request_model=collections_get_request_model,
    ...
)

You will know it is all working when the API docs show the q, bbox, datetime parameters as options for the /collections endpoint.