From c76025f49961136abb19b9d7b327cd7172326ac3 Mon Sep 17 00:00:00 2001 From: jonhealy1 Date: Fri, 24 Oct 2025 19:11:22 +0800 Subject: [PATCH] update readmes --- README.md | 11 ++++++----- stac_fastapi/core/README.md | 12 ++++++++++++ stac_fastapi/elasticsearch/README.md | 12 ++++++++++++ stac_fastapi/opensearch/README.md | 12 ++++++++++++ stac_fastapi/sfeos_helpers/README.md | 12 ++++++++++++ 5 files changed, 54 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 75e88ea6..fb2bdd02 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ The following organizations have contributed time and/or funding to support the ## Latest News +- **10/24/2025:** Added `previous_token` pagination using Redis for efficient navigation. This feature allows users to navigate backwards through large result sets by storing pagination state in Redis. To use this feature, ensure Redis is configured (see [Redis for navigation](#redis-for-navigation)) and set `REDIS_ENABLE=true` in your environment. - **10/23/2025:** The `EXCLUDED_FROM_QUERYABLES` environment variable was added to exclude fields from the `queryables` endpoint. See [docs](#excluding-fields-from-queryables). - **10/15/2025:** 🚀 SFEOS Tools v0.1.0 Released! - The new `sfeos-tools` CLI is now available on [PyPI](https://pypi.org/project/sfeos-tools/) - **10/15/2025:** Added `reindex` command to **[SFEOS-tools](https://github.com/Healy-Hyperspatial/sfeos-tools)** for zero-downtime index updates when changing mappings or settings. The new `reindex` command makes it easy to apply mapping changes, update index settings, or migrate to new index structures without any service interruption, ensuring high availability of your STAC API during maintenance operations. @@ -475,7 +476,7 @@ The system uses a precise naming convention: - **Creating a Collection**: ```shell curl -X "POST" "http://localhost:8080/collections" \ - -H 'Content-Type: application/json; charset=utf-8' \ + -H 'Content-Type: application/json' \ -d $'{ "id": "my_collection" }' @@ -484,14 +485,14 @@ The system uses a precise naming convention: - **Adding an Item to a Collection**: ```shell curl -X "POST" "http://localhost:8080/collections/my_collection/items" \ - -H 'Content-Type: application/json; charset=utf-8' \ + -H 'Content-Type: application/json' \ -d @item.json ``` - **Searching for Items**: ```shell curl -X "GET" "http://localhost:8080/search" \ - -H 'Content-Type: application/json; charset=utf-8' \ + -H 'Content-Type: application/json' \ -d $'{ "collections": ["my_collection"], "limit": 10 @@ -501,7 +502,7 @@ The system uses a precise naming convention: - **Filtering by Bbox**: ```shell curl -X "GET" "http://localhost:8080/search" \ - -H 'Content-Type: application/json; charset=utf-8' \ + -H 'Content-Type: application/json' \ -d $'{ "collections": ["my_collection"], "bbox": [-180, -90, 180, 90] @@ -511,7 +512,7 @@ The system uses a precise naming convention: - **Filtering by Datetime**: ```shell curl -X "GET" "http://localhost:8080/search" \ - -H 'Content-Type: application/json; charset=utf-8' \ + -H 'Content-Type: application/json' \ -d $'{ "collections": ["my_collection"], "datetime": "2020-01-01T00:00:00Z/2020-12-31T23:59:59Z" diff --git a/stac_fastapi/core/README.md b/stac_fastapi/core/README.md index 6f89cb4a..2cc5e413 100644 --- a/stac_fastapi/core/README.md +++ b/stac_fastapi/core/README.md @@ -1,5 +1,17 @@ # stac-fastapi-core +

+ +

+ + [![Downloads](https://static.pepy.tech/badge/stac-fastapi-core?color=blue)](https://pepy.tech/project/stac-fastapi-core) + [![GitHub contributors](https://img.shields.io/github/contributors/stac-utils/stac-fastapi-elasticsearch-opensearch?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/graphs/contributors) + [![GitHub stars](https://img.shields.io/github/stars/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/stargazers) + [![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) + [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/) + [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0) + [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi) + Core functionality for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md). ## Package Information diff --git a/stac_fastapi/elasticsearch/README.md b/stac_fastapi/elasticsearch/README.md index 2ffe21b2..047f03c0 100644 --- a/stac_fastapi/elasticsearch/README.md +++ b/stac_fastapi/elasticsearch/README.md @@ -1,5 +1,17 @@ # stac-fastapi-elasticsearch +

+ +

+ + [![Downloads](https://static.pepy.tech/badge/stac-fastapi-core?color=blue)](https://pepy.tech/project/stac-fastapi-core) + [![GitHub contributors](https://img.shields.io/github/contributors/stac-utils/stac-fastapi-elasticsearch-opensearch?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/graphs/contributors) + [![GitHub stars](https://img.shields.io/github/stars/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/stargazers) + [![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) + [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/) + [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0) + [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi) + This is the Elasticsearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md). ## Package Information diff --git a/stac_fastapi/opensearch/README.md b/stac_fastapi/opensearch/README.md index 27b69841..9355fd3e 100644 --- a/stac_fastapi/opensearch/README.md +++ b/stac_fastapi/opensearch/README.md @@ -1,5 +1,17 @@ # stac-fastapi-opensearch +

+ +

+ + [![Downloads](https://static.pepy.tech/badge/stac-fastapi-core?color=blue)](https://pepy.tech/project/stac-fastapi-core) + [![GitHub contributors](https://img.shields.io/github/contributors/stac-utils/stac-fastapi-elasticsearch-opensearch?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/graphs/contributors) + [![GitHub stars](https://img.shields.io/github/stars/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/stargazers) + [![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) + [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/) + [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0) + [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi) + This is the OpenSearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md). ## Package Information diff --git a/stac_fastapi/sfeos_helpers/README.md b/stac_fastapi/sfeos_helpers/README.md index 108ba60b..c94e499e 100644 --- a/stac_fastapi/sfeos_helpers/README.md +++ b/stac_fastapi/sfeos_helpers/README.md @@ -1,5 +1,17 @@ # sfeos-helpers +

+ +

+ + [![Downloads](https://static.pepy.tech/badge/stac-fastapi-core?color=blue)](https://pepy.tech/project/stac-fastapi-core) + [![GitHub contributors](https://img.shields.io/github/contributors/stac-utils/stac-fastapi-elasticsearch-opensearch?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/graphs/contributors) + [![GitHub stars](https://img.shields.io/github/stars/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/stargazers) + [![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) + [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/) + [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0) + [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi) + Helper utilities for the stac-fastapi project. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md). ## Package Information