emv var to turn off collections-search route

Author: jonhealy1

CHANGELOG.md

@@ -8,13 +8,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 
 ### Added
+- Environment variable `ENABLE_COLLECTIONS_SEARCH_ROUTE` to turn on/off the `/collections-search` endpoint. [#478](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/478)
 - POST and GET `/collections-search` endpoint for collections search queries, needed because POST /collections will not work when the Transactions Extension is enabled. [#478](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/478)
 - GET `/collections` collection search structured filter extension with support for both cql2-json and cql2-text formats. [#475](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/475)
 - GET `/collections` collection search query extension. [#477](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/477)
 - GET `/collections` collections search datetime filtering support. [#476](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/476)
 
 ### Changed
-- Refactored collection search implementation to support both GET and POST methods. [#478](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/478)
+- Refactored `/collections` endpoint implementation to support both GET and POST methods. [#478](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/478)
 
 ### Fixed
 - support of disabled nested attributes in the properties dictionary. [#474](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/474)

README.md

@@ -152,7 +152,9 @@ These endpoints support advanced collection discovery features including:
 
 These extensions make it easier to build user interfaces that display and navigate through collections efficiently.
 
-> **Configuration**: Collection search extensions (sorting, field selection, free text search, structured filtering, and datetime filtering) can be disabled by setting the `ENABLE_COLLECTIONS_SEARCH` environment variable to `false`. By default, these extensions are enabled.
+> **Configuration**: Collection search extensions (sorting, field selection, free text search, structured filtering, and datetime filtering) for the `/collections` endpoint can be disabled by setting the `ENABLE_COLLECTIONS_SEARCH` environment variable to `false`. By default, these extensions are enabled.
+> 
+> **Configuration**: The custom `/collections-search` endpoint can be disabled by setting the `ENABLE_COLLECTIONS_SEARCH_ROUTE` environment variable to `false`. By default, this endpoint is enabled.
 
 > **Note**: Sorting is only available on fields that are indexed for sorting in Elasticsearch/OpenSearch. With the default mappings, you can sort on:
 > - `id` (keyword field)
@@ -294,8 +296,8 @@ You can customize additional settings in your `.env` file:
 | `ENABLE_DIRECT_RESPONSE`     | Enable direct response for maximum performance (disables all FastAPI dependencies, including authentication, custom status codes, and validation) | `false`                  | Optional                       |
 | `RAISE_ON_BULK_ERROR`        | Controls whether bulk insert operations raise exceptions on errors. If set to `true`, the operation will stop and raise an exception when an error occurs. If set to `false`, errors will be logged, and the operation will continue. **Note:** STAC Item and ItemCollection validation errors will always raise, regardless of this flag. | `false` | Optional |
 | `DATABASE_REFRESH`           | Controls whether database operations refresh the index immediately after changes. If set to `true`, changes will be immediately searchable. If set to `false`, changes may not be immediately visible but can improve performance for bulk operations. If set to `wait_for`, changes will wait for the next refresh cycle to become visible. | `false` | Optional |
-| `ENABLE_COLLECTIONS_SEARCH`  | Enable collection search extensions (sort, fields, free text search, structured filtering, and datetime filtering).                                 | `true`                   | Optional                                                                                    |
-| `ENABLE_TRANSACTIONS_EXTENSIONS` | Enables or disables the Transactions and Bulk Transactions API extensions. If set to `false`, the POST `/collections` route and related transaction endpoints (including bulk transaction operations) will be unavailable in the API. This is useful for deployments where mutating the catalog via the API should be prevented. | `true` | Optional |
+| `ENABLE_COLLECTIONS_SEARCH`  | Enable collection search extensions (sort, fields, free text search, structured filtering, and datetime filtering) on the core `/collections` endpoint. | `true`                   | Optional                                                                                    |
+| `ENABLE_COLLECTIONS_SEARCH_ROUTE` | Enable the custom `/collections-search` endpoint (both GET and POST methods). When disabled, the custom endpoint will not be available, but collection search extensions will still be available on the core `/collections` endpoint if `ENABLE_COLLECTIONS_SEARCH` is true. | `true` | Optional |
 | `STAC_ITEM_LIMIT` | Sets the environment variable for result limiting to SFEOS for the number of returned items and STAC collections. | `10` | Optional |
 | `STAC_INDEX_ASSETS` | Controls if Assets are indexed when added to Elasticsearch/Opensearch. This allows asset fields to be included in search queries. | `false` | Optional |
 | `ENV_MAX_LIMIT` | Configures the environment variable in SFEOS to override the default `MAX_LIMIT`, which controls the limit parameter for returned items and STAC collections. | `10,000` | Optional |

compose.yml

@@ -22,6 +22,8 @@ services:
       - ES_VERIFY_CERTS=false
       - BACKEND=elasticsearch
       - DATABASE_REFRESH=true
+      - ENABLE_COLLECTIONS_SEARCH=true
+      - ENABLE_COLLECTIONS_SEARCH_ROUTE=true
     ports:
       - "8080:8080"
     volumes:
@@ -56,6 +58,8 @@ services:
       - ES_VERIFY_CERTS=false
       - BACKEND=opensearch
       - STAC_FASTAPI_RATE_LIMIT=200/minute
+      - ENABLE_COLLECTIONS_SEARCH=true
+      - ENABLE_COLLECTIONS_SEARCH_ROUTE=true
     ports:
       - "8082:8082"
     volumes:

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py

@@ -62,8 +62,14 @@
 
 TRANSACTIONS_EXTENSIONS = get_bool_env("ENABLE_TRANSACTIONS_EXTENSIONS", default=True)
 ENABLE_COLLECTIONS_SEARCH = get_bool_env("ENABLE_COLLECTIONS_SEARCH", default=True)
+ENABLE_COLLECTIONS_SEARCH_ROUTE = get_bool_env(
+    "ENABLE_COLLECTIONS_SEARCH_ROUTE", default=True
+)
 logger.info("TRANSACTIONS_EXTENSIONS is set to %s", TRANSACTIONS_EXTENSIONS)
 logger.info("ENABLE_COLLECTIONS_SEARCH is set to %s", ENABLE_COLLECTIONS_SEARCH)
+logger.info(
+    "ENABLE_COLLECTIONS_SEARCH_ROUTE is set to %s", ENABLE_COLLECTIONS_SEARCH_ROUTE
+)
 
 settings = ElasticsearchSettings()
 session = Session.create_from_settings(settings)
@@ -124,8 +130,7 @@
 # Collection search related variables
 collections_get_request_model = None
 
-# Create collection search extensions if enabled
-if ENABLE_COLLECTIONS_SEARCH:
+if ENABLE_COLLECTIONS_SEARCH or ENABLE_COLLECTIONS_SEARCH_ROUTE:
     # Create collection search extensions
     collection_search_extensions = [
         QueryExtension(conformance_classes=[QueryConformanceClasses.COLLECTIONS]),
@@ -148,6 +153,8 @@
         collection_search_extensions
     )
 
+# Create collection search extensions if enabled
+if ENABLE_COLLECTIONS_SEARCH:
     # Initialize collection search POST extension
     collection_search_post_ext = CollectionSearchPostExtension(
         client=CoreClient(
@@ -167,7 +174,10 @@
             FieldsConformanceClasses.COLLECTIONS,
         ],
     )
+    extensions.append(collection_search_ext)
+    extensions.append(collection_search_post_ext)
 
+if ENABLE_COLLECTIONS_SEARCH_ROUTE:
     # Initialize collections-search endpoint extension
     collections_search_endpoint_ext = CollectionsSearchEndpointExtension(
         client=CoreClient(
@@ -188,9 +198,6 @@
             FieldsConformanceClasses.COLLECTIONS,
         ],
     )
-
-    extensions.append(collection_search_ext)
-    extensions.append(collection_search_post_ext)
     extensions.append(collections_search_endpoint_ext)
 
 
@@ -250,6 +257,7 @@ async def lifespan(app: FastAPI):
 app = api.app
 app.router.lifespan_context = lifespan
 app.root_path = os.getenv("STAC_FASTAPI_ROOT_PATH", "")
+
 # Add rate limit
 setup_rate_limit(app, rate_limit=os.getenv("STAC_FASTAPI_RATE_LIMIT"))
 

stac_fastapi/opensearch/stac_fastapi/opensearch/app.py

@@ -62,8 +62,14 @@
 
 TRANSACTIONS_EXTENSIONS = get_bool_env("ENABLE_TRANSACTIONS_EXTENSIONS", default=True)
 ENABLE_COLLECTIONS_SEARCH = get_bool_env("ENABLE_COLLECTIONS_SEARCH", default=True)
+ENABLE_COLLECTIONS_SEARCH_ROUTE = get_bool_env(
+    "ENABLE_COLLECTIONS_SEARCH_ROUTE", default=True
+)
 logger.info("TRANSACTIONS_EXTENSIONS is set to %s", TRANSACTIONS_EXTENSIONS)
 logger.info("ENABLE_COLLECTIONS_SEARCH is set to %s", ENABLE_COLLECTIONS_SEARCH)
+logger.info(
+    "ENABLE_COLLECTIONS_SEARCH_ROUTE is set to %s", ENABLE_COLLECTIONS_SEARCH_ROUTE
+)
 
 settings = OpensearchSettings()
 session = Session.create_from_settings(settings)
@@ -124,8 +130,10 @@
 # Collection search related variables
 collections_get_request_model = None
 
-# Create collection search extensions if enabled
-if ENABLE_COLLECTIONS_SEARCH:
+# Collection search related variables
+collections_get_request_model = None
+
+if ENABLE_COLLECTIONS_SEARCH or ENABLE_COLLECTIONS_SEARCH_ROUTE:
     # Create collection search extensions
     collection_search_extensions = [
         QueryExtension(conformance_classes=[QueryConformanceClasses.COLLECTIONS]),
@@ -148,6 +156,8 @@
         collection_search_extensions
     )
 
+# Create collection search extensions if enabled
+if ENABLE_COLLECTIONS_SEARCH:
     # Initialize collection search POST extension
     collection_search_post_ext = CollectionSearchPostExtension(
         client=CoreClient(
@@ -163,12 +173,14 @@
             QueryConformanceClasses.COLLECTIONS,
             FilterConformanceClasses.COLLECTIONS,
             FreeTextConformanceClasses.COLLECTIONS,
-            QueryConformanceClasses.COLLECTIONS,
             SortConformanceClasses.COLLECTIONS,
             FieldsConformanceClasses.COLLECTIONS,
         ],
     )
+    extensions.append(collection_search_ext)
+    extensions.append(collection_search_post_ext)
 
+if ENABLE_COLLECTIONS_SEARCH_ROUTE:
     # Initialize collections-search endpoint extension
     collections_search_endpoint_ext = CollectionsSearchEndpointExtension(
         client=CoreClient(
@@ -185,14 +197,10 @@
             QueryConformanceClasses.COLLECTIONS,
             FilterConformanceClasses.COLLECTIONS,
             FreeTextConformanceClasses.COLLECTIONS,
-            QueryConformanceClasses.COLLECTIONS,
             SortConformanceClasses.COLLECTIONS,
             FieldsConformanceClasses.COLLECTIONS,
         ],
     )
-
-    extensions.append(collection_search_ext)
-    extensions.append(collection_search_post_ext)
     extensions.append(collections_search_endpoint_ext)