Skip to content

Commit 379ea80

Browse files
Yuri ZmytrakovYuri Zmytrakov
authored andcommitted
docs: updated readme and changelog about hidden_private_data env var
1 parent e0f53e9 commit 379ea80

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
99

1010
### Added
1111

12+
- Added environment variables `HIDE_PRIVATE_DATA` and `PRIVATE_DATA_FIELD` to control visibility of private technical data fields in SFEOS responses. [#518](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/518)
13+
1214
### Changed
1315

1416
### Fixed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,9 @@ You can customize additional settings in your `.env` file:
342342
| `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 |
343343
| `USE_DATETIME` | Configures the datetime search behavior in SFEOS. When enabled, searches both datetime field and falls back to start_datetime/end_datetime range for items with null datetime. When disabled, searches only by start_datetime/end_datetime range. | `true` | Optional |
344344
| `EXCLUDED_FROM_QUERYABLES` | Comma-separated list of fully qualified field names to exclude from the queryables endpoint and filtering. Use full paths like `properties.auth:schemes,properties.storage:schemes`. Excluded fields and their nested children will not be exposed in queryables. | None | Optional |
345+
| `HIDE_PRIVATE_DATA` | Controls whether private or technical data fields are included in responses. When set to `true`, private data is hidden from the output, when `false`, it is returned as part of the response. | `false` | Optional |
346+
| `PRIVATE_DATA_FIELD` | Specifies the name of the field that should be considered private data and hidden from responses when `HIDE_PRIVATE_DATA` is enabled. This field will be removed from all STAC item responses. | `None` | Optional |
347+
345348

346349
> [!NOTE]
347350
> 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.

0 commit comments

Comments
 (0)