Skip to content

Commit a1b7eee

Browse files
committed
update readme
1 parent cdd673f commit a1b7eee

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ This project is built on the following technologies: STAC, stac-fastapi, FastAPI
6666
## Table of Contents
6767

6868
- [stac-fastapi-elasticsearch-opensearch](#stac-fastapi-elasticsearch-opensearch)
69-
- [Sponsors \& Supporters](#sponsors--supporters)
69+
- [Sponsors & Supporters](#sponsors--supporters)
7070
- [Project Introduction - What is SFEOS?](#project-introduction---what-is-sfeos)
7171
- [Common Deployment Patterns](#common-deployment-patterns)
7272
- [Technologies](#technologies)
7373
- [Table of Contents](#table-of-contents)
7474
- [Collection Search Extensions](#collection-search-extensions)
75-
- [Documentation \& Resources](#documentation--resources)
75+
- [Documentation & Resources](#documentation--resources)
7676
- [Package Structure](#package-structure)
7777
- [Examples](#examples)
7878
- [Performance](#performance)
@@ -115,7 +115,11 @@ This project is built on the following technologies: STAC, stac-fastapi, FastAPI
115115

116116
## Collection Search Extensions
117117

118-
SFEOS implements extended capabilities for the `/collections` endpoint, allowing for more powerful collection discovery:
118+
SFEOS provides enhanced collection search capabilities through two primary routes:
119+
- **GET/POST `/collections`**: The standard STAC endpoint with extended query parameters
120+
- **GET/POST `/collections-search`**: A custom endpoint that supports the same parameters, created to avoid conflicts with the STAC Transactions extension if enabled (which uses POST `/collections` for collection creation)
121+
122+
These endpoints support advanced collection discovery features including:
119123

120124
- **Sorting**: Sort collections by sortable fields using the `sortby` parameter
121125
- Example: `/collections?sortby=+id` (ascending sort by ID)
@@ -146,8 +150,6 @@ SFEOS implements extended capabilities for the `/collections` endpoint, allowing
146150
- Collections are matched if their temporal extent overlaps with the provided datetime parameter
147151
- This allows for efficient discovery of collections based on time periods
148152

149-
> **Note on HTTP Methods**: All collection search extensions (sorting, field selection, free text search, structured filtering, and datetime filtering) currently only support GET requests. POST requests with these parameters in the request body are not yet supported.
150-
151153
These extensions make it easier to build user interfaces that display and navigate through collections efficiently.
152154

153155
> **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.
@@ -161,6 +163,7 @@ These extensions make it easier to build user interfaces that display and naviga
161163
>
162164
> **Important**: Adding keyword fields to make text fields sortable can significantly increase the index size, especially for large text fields. Consider the storage implications when deciding which fields to make sortable.
163165
166+
164167
## Package Structure
165168

166169
This project is organized into several packages, each with a specific purpose:
@@ -442,7 +445,6 @@ The system uses a precise naming convention:
442445
- `ENABLE_COLLECTIONS_SEARCH`: Set to `true` (default) to enable collection search extensions (sort, fields). Set to `false` to disable.
443446
- `ENABLE_TRANSACTIONS_EXTENSIONS`: Set to `true` (default) to enable transaction extensions. Set to `false` to disable.
444447

445-
446448
## Collection Pagination
447449

448450
- **Overview**: The collections route supports pagination through optional query parameters.

0 commit comments

Comments
 (0)