Skip to content

Commit d26e573

Browse files
committed
updated readme
1 parent 9e8f8a9 commit d26e573

File tree

3 files changed

+27
-26
lines changed

3 files changed

+27
-26
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+
- CloudFerro logo to sponsors and supporters list [#485](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/485)
13+
- Latest news section to README [#485](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/485)
1214
- Environment variable `EXCLUDED_FROM_QUERYABLES` to exclude specific fields from queryables endpoint and filtering. Supports comma-separated list of fully qualified field names (e.g., `properties.auth:schemes,properties.storage:schemes`) [#489](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/489)
1315

1416
### Changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ This project is built on the following technologies: STAC, stac-fastapi, FastAPI
102102
- [Using Pre-built Docker Images](#using-pre-built-docker-images)
103103
- [Using Docker Compose](#using-docker-compose)
104104
- [Configuration Reference](#configuration-reference)
105+
- [Excluding Fields from Queryables](#excluding-fields-from-queryables)
105106
- [Datetime-Based Index Management](#datetime-based-index-management)
106107
- [Overview](#overview)
107108
- [When to Use](#when-to-use)
@@ -342,6 +343,30 @@ You can customize additional settings in your `.env` file:
342343
> [!NOTE]
343344
> 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.
344345
346+
## Excluding Fields from Queryables
347+
348+
You can exclude specific fields from being exposed in the queryables endpoint and from filtering by setting the `EXCLUDED_FROM_QUERYABLES` environment variable. This is useful for hiding sensitive or internal fields that should not be queryable by API users.
349+
350+
**Environment Variable:**
351+
352+
```bash
353+
EXCLUDED_FROM_QUERYABLES="properties.auth:schemes,properties.storage:schemes,properties.internal:metadata"
354+
```
355+
356+
**Format:**
357+
358+
- Comma-separated list of fully qualified field names
359+
- Use the full path including the `properties.` prefix for item properties
360+
- Example field names:
361+
- `properties.auth:schemes`
362+
- `properties.storage:schemes`
363+
364+
**Behavior:**
365+
366+
- Excluded fields will not appear in the queryables response
367+
- Excluded fields and their nested children will be skipped during field traversal
368+
- Both the field itself and any nested properties will be excluded
369+
345370
## Datetime-Based Index Management
346371

347372
### Overview

stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/filter/README.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,6 @@ The filter package is organized into three main modules:
2121
- **client.py**: Contains the base filter client implementation
2222
- [EsAsyncBaseFiltersClient](cci:2://file:///home/computer/Code/stac-fastapi-elasticsearch-opensearch/stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/filter.py:209:0-293:25): Base class for implementing the STAC filter extension
2323

24-
## Configuration
25-
26-
### Excluding Fields from Queryables
27-
28-
You can exclude specific fields from being exposed in the queryables endpoint and from filtering by setting the `EXCLUDED_FROM_QUERYABLES` environment variable. This is useful for hiding sensitive or internal fields that should not be queryable by API users.
29-
30-
**Environment Variable:**
31-
32-
```bash
33-
EXCLUDED_FROM_QUERYABLES="properties.auth:schemes,properties.storage:schemes,properties.internal:metadata"
34-
```
35-
36-
**Format:**
37-
38-
- Comma-separated list of fully qualified field names
39-
- Use the full path including the `properties.` prefix for item properties
40-
- Example field names:
41-
- `properties.auth:schemes`
42-
- `properties.storage:schemes`
43-
44-
**Behavior:**
45-
46-
- Excluded fields will not appear in the queryables response
47-
- Excluded fields and their nested children will be skipped during field traversal
48-
- Both the field itself and any nested properties will be excluded
49-
5024
## Usage
5125

5226
Import the necessary components from the filter package:

0 commit comments

Comments
 (0)