stac-fastapi-opensearch 6.0.0__tar.gz → 6.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/PKG-INFO +15 -13
  2. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/README.md +14 -12
  3. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/setup.py +2 -2
  4. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi/opensearch/app.py +11 -1
  5. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi/opensearch/config.py +4 -0
  6. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi/opensearch/database_logic.py +10 -2
  7. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi/opensearch/version.py +1 -1
  8. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi_opensearch.egg-info/PKG-INFO +15 -13
  9. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi_opensearch.egg-info/requires.txt +2 -2
  10. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/setup.cfg +0 -0
  11. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi/opensearch/__init__.py +0 -0
  12. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi_opensearch.egg-info/SOURCES.txt +0 -0
  13. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi_opensearch.egg-info/dependency_links.txt +0 -0
  14. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi_opensearch.egg-info/entry_points.txt +0 -0
  15. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi_opensearch.egg-info/not-zip-safe +0 -0
  16. {stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi_opensearch.egg-info/top_level.txt +0 -0
{stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: stac_fastapi_opensearch
3
- Version: 6.0.0
3
+ Version: 6.1.0
4
4
  Summary: Opensearch stac-fastapi backend.
5
5
  Home-page: https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
6
6
  License: MIT
@@ -36,7 +36,7 @@ Provides-Extra: server
36
36
  [![GitHub forks](https://img.shields.io/github/forks/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/network/members)
37
37
  [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/)
38
38
  [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
39
- [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-5.2.0-blue.svg)](https://github.com/stac-utils/stac-fastapi)
39
+ [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi)
40
40
 
41
41
  ## Sponsors & Supporters
42
42
 
@@ -226,28 +226,30 @@ You can customize additional settings in your `.env` file:
226
226
  |------------------------------|--------------------------------------------------------------------------------------|--------------------------|---------------------------------------------------------------------------------------------|
227
227
  | `ES_HOST` | Hostname for external Elasticsearch/OpenSearch. | `localhost` | Optional |
228
228
  | `ES_PORT` | Port for Elasticsearch/OpenSearch. | `9200` (ES) / `9202` (OS)| Optional |
229
- | `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `false` | Optional |
230
- | `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `false` | Optional |
229
+ | `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `true` | Optional |
230
+ | `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `true` | Optional |
231
+ | `ES_API_KEY` | API Key for external Elasticsearch/OpenSearch. | N/A | Optional |
232
+ | `ES_TIMEOUT` | Client timeout for Elasticsearch/OpenSearch. | DB client default | Optional |
231
233
  | `STAC_FASTAPI_TITLE` | Title of the API in the documentation. | `stac-fastapi-<backend>` | Optional |
232
234
  | `STAC_FASTAPI_DESCRIPTION` | Description of the API in the documentation. | N/A | Optional |
233
235
  | `STAC_FASTAPI_VERSION` | API version. | `2.1` | Optional |
234
- | `STAC_FASTAPI_LANDING_PAGE_ID` | Landing page ID | `stac-fastapi` | Optional |
236
+ | `STAC_FASTAPI_LANDING_PAGE_ID` | Landing page ID | `stac-fastapi` | Optional |
235
237
  | `APP_HOST` | Server bind address. | `0.0.0.0` | Optional |
236
- | `APP_PORT` | Server port. | `8080` | Optional |
238
+ | `APP_PORT` | Server port. | `8000` | Optional |
237
239
  | `ENVIRONMENT` | Runtime environment. | `local` | Optional |
238
240
  | `WEB_CONCURRENCY` | Number of worker processes. | `10` | Optional |
239
241
  | `RELOAD` | Enable auto-reload for development. | `true` | Optional |
240
242
  | `STAC_FASTAPI_RATE_LIMIT` | API rate limit per client. | `200/minute` | Optional |
241
- | `BACKEND` | Tests-related variable | `elasticsearch` or `opensearch` based on the backend | Optional |
242
- | `ELASTICSEARCH_VERSION` | Version of Elasticsearch to use. | `8.11.0` | Optional | |
243
- | `OPENSEARCH_VERSION` | OpenSearch version | `2.11.1` | Optional
244
- | `ENABLE_DIRECT_RESPONSE` | Enable direct response for maximum performance (disables all FastAPI dependencies, including authentication, custom status codes, and validation) | `false` | Optional
245
- | `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 |
246
- | `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 |
243
+ | `BACKEND` | Tests-related variable | `elasticsearch` or `opensearch` based on the backend | Optional |
244
+ | `ELASTICSEARCH_VERSION` | Version of Elasticsearch to use. | `8.11.0` | Optional |
245
+ | `OPENSEARCH_VERSION` | OpenSearch version | `2.11.1` | Optional |
246
+ | `ENABLE_DIRECT_RESPONSE` | Enable direct response for maximum performance (disables all FastAPI dependencies, including authentication, custom status codes, and validation) | `false` | Optional |
247
+ | `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 |
248
+ | `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 |
247
249
  | `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 |
248
250
 
249
251
  > [!NOTE]
250
- > The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, and `ES_VERIFY_CERTS` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.
252
+ > The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, `ES_VERIFY_CERTS` and `ES_TIMEOUT` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.
251
253
 
252
254
  ## Interacting with the API
253
255
 
{stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/README.md RENAMED
@@ -15,7 +15,7 @@
15
15
  [![GitHub forks](https://img.shields.io/github/forks/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/network/members)
16
16
  [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/)
17
17
  [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
18
- [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-5.2.0-blue.svg)](https://github.com/stac-utils/stac-fastapi)
18
+ [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi)
19
19
 
20
20
  ## Sponsors & Supporters
21
21
 
@@ -205,28 +205,30 @@ You can customize additional settings in your `.env` file:
205
205
  |------------------------------|--------------------------------------------------------------------------------------|--------------------------|---------------------------------------------------------------------------------------------|
206
206
  | `ES_HOST` | Hostname for external Elasticsearch/OpenSearch. | `localhost` | Optional |
207
207
  | `ES_PORT` | Port for Elasticsearch/OpenSearch. | `9200` (ES) / `9202` (OS)| Optional |
208
- | `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `false` | Optional |
209
- | `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `false` | Optional |
208
+ | `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `true` | Optional |
209
+ | `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `true` | Optional |
210
+ | `ES_API_KEY` | API Key for external Elasticsearch/OpenSearch. | N/A | Optional |
211
+ | `ES_TIMEOUT` | Client timeout for Elasticsearch/OpenSearch. | DB client default | Optional |
210
212
  | `STAC_FASTAPI_TITLE` | Title of the API in the documentation. | `stac-fastapi-<backend>` | Optional |
211
213
  | `STAC_FASTAPI_DESCRIPTION` | Description of the API in the documentation. | N/A | Optional |
212
214
  | `STAC_FASTAPI_VERSION` | API version. | `2.1` | Optional |
213
- | `STAC_FASTAPI_LANDING_PAGE_ID` | Landing page ID | `stac-fastapi` | Optional |
215
+ | `STAC_FASTAPI_LANDING_PAGE_ID` | Landing page ID | `stac-fastapi` | Optional |
214
216
  | `APP_HOST` | Server bind address. | `0.0.0.0` | Optional |
215
- | `APP_PORT` | Server port. | `8080` | Optional |
217
+ | `APP_PORT` | Server port. | `8000` | Optional |
216
218
  | `ENVIRONMENT` | Runtime environment. | `local` | Optional |
217
219
  | `WEB_CONCURRENCY` | Number of worker processes. | `10` | Optional |
218
220
  | `RELOAD` | Enable auto-reload for development. | `true` | Optional |
219
221
  | `STAC_FASTAPI_RATE_LIMIT` | API rate limit per client. | `200/minute` | Optional |
220
- | `BACKEND` | Tests-related variable | `elasticsearch` or `opensearch` based on the backend | Optional |
221
- | `ELASTICSEARCH_VERSION` | Version of Elasticsearch to use. | `8.11.0` | Optional | |
222
- | `OPENSEARCH_VERSION` | OpenSearch version | `2.11.1` | Optional
223
- | `ENABLE_DIRECT_RESPONSE` | Enable direct response for maximum performance (disables all FastAPI dependencies, including authentication, custom status codes, and validation) | `false` | Optional
224
- | `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 |
225
- | `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 |
222
+ | `BACKEND` | Tests-related variable | `elasticsearch` or `opensearch` based on the backend | Optional |
223
+ | `ELASTICSEARCH_VERSION` | Version of Elasticsearch to use. | `8.11.0` | Optional |
224
+ | `OPENSEARCH_VERSION` | OpenSearch version | `2.11.1` | Optional |
225
+ | `ENABLE_DIRECT_RESPONSE` | Enable direct response for maximum performance (disables all FastAPI dependencies, including authentication, custom status codes, and validation) | `false` | Optional |
226
+ | `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 |
227
+ | `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 |
226
228
  | `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 |
227
229
 
228
230
  > [!NOTE]
229
- > The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, and `ES_VERIFY_CERTS` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.
231
+ > The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, `ES_VERIFY_CERTS` and `ES_TIMEOUT` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.
230
232
 
231
233
  ## Interacting with the API
232
234
 
{stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/setup.py RENAMED
@@ -6,8 +6,8 @@ with open("README.md") as f:
6
6
  desc = f.read()
7
7
 
8
8
  install_requires = [
9
- "stac-fastapi-core==6.0.0",
10
- "sfeos-helpers==6.0.0",
9
+ "stac-fastapi-core==6.1.0",
10
+ "sfeos-helpers==6.1.0",
11
11
  "opensearch-py~=2.8.0",
12
12
  "opensearch-py[async]~=2.8.0",
13
13
  "uvicorn~=0.23.0",
{stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi/opensearch/app.py RENAMED
@@ -25,6 +25,7 @@ from stac_fastapi.core.session import Session
25
25
  from stac_fastapi.core.utilities import get_bool_env
26
26
  from stac_fastapi.extensions.core import (
27
27
  AggregationExtension,
28
+ CollectionSearchExtension,
28
29
  FilterExtension,
29
30
  FreeTextExtension,
30
31
  SortExtension,
@@ -60,6 +61,14 @@ filter_extension.conformance_classes.append(
60
61
  FilterConformanceClasses.ADVANCED_COMPARISON_OPERATORS
61
62
  )
62
63
 
64
+ # Adding collection search extension for compatibility with stac-auth-proxy
65
+ # (https://github.com/developmentseed/stac-auth-proxy)
66
+ # The extension is not fully implemented yet but is required for collection filtering support
67
+ collection_search_extension = CollectionSearchExtension()
68
+ collection_search_extension.conformance_classes.append(
69
+ "https://api.stacspec.org/v1.0.0-rc.1/collection-search#filter"
70
+ )
71
+
63
72
  aggregation_extension = AggregationExtension(
64
73
  client=EsAsyncBaseAggregationClient(
65
74
  database=database_logic, session=session, settings=settings
@@ -75,6 +84,7 @@ search_extensions = [
75
84
  TokenPaginationExtension(),
76
85
  filter_extension,
77
86
  FreeTextExtension(),
87
+ collection_search_extension,
78
88
  ]
79
89
 
80
90
 
@@ -108,7 +118,7 @@ post_request_model = create_post_request_model(search_extensions)
108
118
  app_config = {
109
119
  "title": os.getenv("STAC_FASTAPI_TITLE", "stac-fastapi-opensearch"),
110
120
  "description": os.getenv("STAC_FASTAPI_DESCRIPTION", "stac-fastapi-opensearch"),
111
- "api_version": os.getenv("STAC_FASTAPI_VERSION", "6.0.0"),
121
+ "api_version": os.getenv("STAC_FASTAPI_VERSION", "6.1.0"),
112
122
  "settings": settings,
113
123
  "extensions": extensions,
114
124
  "client": CoreClient(
{stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi/opensearch/config.py RENAMED
@@ -53,6 +53,10 @@ def _es_config() -> Dict[str, Any]:
53
53
 
54
54
  config["headers"] = headers
55
55
 
56
+ # Include timeout setting if set
57
+ if timeout := os.getenv("ES_TIMEOUT"):
58
+ config["timeout"] = timeout
59
+
56
60
  # Explicitly exclude SSL settings when not using SSL
57
61
  if not use_ssl:
58
62
  return config
{stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi/opensearch/database_logic.py RENAMED
@@ -42,6 +42,10 @@ from stac_fastapi.sfeos_helpers.database import (
42
42
  return_date,
43
43
  validate_refresh,
44
44
  )
45
+ from stac_fastapi.sfeos_helpers.database.query import (
46
+ ES_MAX_URL_LENGTH,
47
+ add_collections_to_body,
48
+ )
45
49
  from stac_fastapi.sfeos_helpers.database.utils import (
46
50
  merge_to_operations,
47
51
  operations_to_script,
@@ -532,6 +536,12 @@ class DatabaseLogic(BaseDatabaseLogic):
532
536
  """
533
537
  search_body: Dict[str, Any] = {}
534
538
  query = search.query.to_dict() if search.query else None
539
+
540
+ index_param = indices(collection_ids)
541
+ if len(index_param) > ES_MAX_URL_LENGTH - 300:
542
+ index_param = ITEM_INDICES
543
+ query = add_collections_to_body(collection_ids, query)
544
+
535
545
  if query:
536
546
  search_body["query"] = query
537
547
 
@@ -544,8 +554,6 @@ class DatabaseLogic(BaseDatabaseLogic):
544
554
 
545
555
  search_body["sort"] = sort if sort else DEFAULT_SORT
546
556
 
547
- index_param = indices(collection_ids)
548
-
549
557
  max_result_window = MAX_LIMIT
550
558
 
551
559
  size_limit = min(limit + 1, max_result_window)
{stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi/opensearch/version.py RENAMED
@@ -1,2 +1,2 @@
1
1
  """library version."""
2
- __version__ = "6.0.0"
2
+ __version__ = "6.1.0"
{stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi_opensearch.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: stac-fastapi-opensearch
3
- Version: 6.0.0
3
+ Version: 6.1.0
4
4
  Summary: Opensearch stac-fastapi backend.
5
5
  Home-page: https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
6
6
  License: MIT
@@ -36,7 +36,7 @@ Provides-Extra: server
36
36
  [![GitHub forks](https://img.shields.io/github/forks/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/network/members)
37
37
  [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/)
38
38
  [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
39
- [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-5.2.0-blue.svg)](https://github.com/stac-utils/stac-fastapi)
39
+ [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi)
40
40
 
41
41
  ## Sponsors & Supporters
42
42
 
@@ -226,28 +226,30 @@ You can customize additional settings in your `.env` file:
226
226
  |------------------------------|--------------------------------------------------------------------------------------|--------------------------|---------------------------------------------------------------------------------------------|
227
227
  | `ES_HOST` | Hostname for external Elasticsearch/OpenSearch. | `localhost` | Optional |
228
228
  | `ES_PORT` | Port for Elasticsearch/OpenSearch. | `9200` (ES) / `9202` (OS)| Optional |
229
- | `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `false` | Optional |
230
- | `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `false` | Optional |
229
+ | `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `true` | Optional |
230
+ | `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `true` | Optional |
231
+ | `ES_API_KEY` | API Key for external Elasticsearch/OpenSearch. | N/A | Optional |
232
+ | `ES_TIMEOUT` | Client timeout for Elasticsearch/OpenSearch. | DB client default | Optional |
231
233
  | `STAC_FASTAPI_TITLE` | Title of the API in the documentation. | `stac-fastapi-<backend>` | Optional |
232
234
  | `STAC_FASTAPI_DESCRIPTION` | Description of the API in the documentation. | N/A | Optional |
233
235
  | `STAC_FASTAPI_VERSION` | API version. | `2.1` | Optional |
234
- | `STAC_FASTAPI_LANDING_PAGE_ID` | Landing page ID | `stac-fastapi` | Optional |
236
+ | `STAC_FASTAPI_LANDING_PAGE_ID` | Landing page ID | `stac-fastapi` | Optional |
235
237
  | `APP_HOST` | Server bind address. | `0.0.0.0` | Optional |
236
- | `APP_PORT` | Server port. | `8080` | Optional |
238
+ | `APP_PORT` | Server port. | `8000` | Optional |
237
239
  | `ENVIRONMENT` | Runtime environment. | `local` | Optional |
238
240
  | `WEB_CONCURRENCY` | Number of worker processes. | `10` | Optional |
239
241
  | `RELOAD` | Enable auto-reload for development. | `true` | Optional |
240
242
  | `STAC_FASTAPI_RATE_LIMIT` | API rate limit per client. | `200/minute` | Optional |
241
- | `BACKEND` | Tests-related variable | `elasticsearch` or `opensearch` based on the backend | Optional |
242
- | `ELASTICSEARCH_VERSION` | Version of Elasticsearch to use. | `8.11.0` | Optional | |
243
- | `OPENSEARCH_VERSION` | OpenSearch version | `2.11.1` | Optional
244
- | `ENABLE_DIRECT_RESPONSE` | Enable direct response for maximum performance (disables all FastAPI dependencies, including authentication, custom status codes, and validation) | `false` | Optional
245
- | `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 |
246
- | `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 |
243
+ | `BACKEND` | Tests-related variable | `elasticsearch` or `opensearch` based on the backend | Optional |
244
+ | `ELASTICSEARCH_VERSION` | Version of Elasticsearch to use. | `8.11.0` | Optional |
245
+ | `OPENSEARCH_VERSION` | OpenSearch version | `2.11.1` | Optional |
246
+ | `ENABLE_DIRECT_RESPONSE` | Enable direct response for maximum performance (disables all FastAPI dependencies, including authentication, custom status codes, and validation) | `false` | Optional |
247
+ | `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 |
248
+ | `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 |
247
249
  | `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 |
248
250
 
249
251
  > [!NOTE]
250
- > The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, and `ES_VERIFY_CERTS` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.
252
+ > The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, `ES_VERIFY_CERTS` and `ES_TIMEOUT` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.
251
253
 
252
254
  ## Interacting with the API
253
255
 
{stac_fastapi_opensearch-6.0.0 → stac_fastapi_opensearch-6.1.0}/stac_fastapi_opensearch.egg-info/requires.txt RENAMED
@@ -1,5 +1,5 @@
1
- stac-fastapi-core==6.0.0
2
- sfeos-helpers==6.0.0
1
+ stac-fastapi-core==6.1.0
2
+ sfeos-helpers==6.1.0
3
3
  opensearch-py~=2.8.0
4
4
  opensearch-py[async]~=2.8.0
5
5
  uvicorn~=0.23.0