You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -115,7 +115,11 @@ This project is built on the following technologies: STAC, stac-fastapi, FastAPI
115
115
116
116
## Collection Search Extensions
117
117
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:
119
123
120
124
-**Sorting**: Sort collections by sortable fields using the `sortby` parameter
121
125
- Example: `/collections?sortby=+id` (ascending sort by ID)
@@ -146,8 +150,6 @@ SFEOS implements extended capabilities for the `/collections` endpoint, allowing
146
150
- Collections are matched if their temporal extent overlaps with the provided datetime parameter
147
151
- This allows for efficient discovery of collections based on time periods
148
152
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
-
151
153
These extensions make it easier to build user interfaces that display and navigate through collections efficiently.
152
154
153
155
> **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
161
163
>
162
164
> **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.
163
165
166
+
164
167
## Package Structure
165
168
166
169
This project is organized into several packages, each with a specific purpose:
@@ -442,7 +445,6 @@ The system uses a precise naming convention:
442
445
-`ENABLE_COLLECTIONS_SEARCH`: Set to `true` (default) to enable collection search extensions (sort, fields). Set to `false` to disable.
443
446
-`ENABLE_TRANSACTIONS_EXTENSIONS`: Set to `true` (default) to enable transaction extensions. Set to `false` to disable.
444
447
445
-
446
448
## Collection Pagination
447
449
448
450
-**Overview**: The collections route supports pagination through optional query parameters.
0 commit comments