simplify error message, add alias

Author: jonhealy1

CHANGELOG.md

@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Added `USE_DATETIME` environment variable to configure datetime search behavior in SFEOS. [#452](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/452)
-- GET `/collections` collection search sort extension ex. `/collections?sortby=+id`. [#456](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/456)
+- GET `/collections` collection search sort extension ex. `/collections?sortby=+id`. Added field alias for `temporal` to enable sorting by temporal extent. [#456](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/456)
 - GET `/collections` collection search fields extension ex. `/collections?fields=id,title`. [#465](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/465)
 - Improved error messages for sorting on unsortable fields in collection search, including guidance on how to make fields sortable. [#465](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/465)
 

README.md

@@ -120,6 +120,7 @@ SFEOS implements extended capabilities for the `/collections` endpoint, allowing
 - **Sorting**: Sort collections by sortable fields using the `sortby` parameter
   - Example: `/collections?sortby=+id` (ascending sort by ID)
   - Example: `/collections?sortby=-id` (descending sort by ID)
+  - Example: `/collections?sortby=-temporal` (descending sort by temporal extent)
 
 - **Field Selection**: Request only specific fields to be returned using the `fields` parameter
   - Example: `/collections?fields=id,title,description`
@@ -130,8 +131,11 @@ These extensions make it easier to build user interfaces that display and naviga
 > **Note**: Sorting is only available on fields that are indexed for sorting in Elasticsearch/OpenSearch. With the default mappings, you can sort on:
 > - `id` (keyword field)
 > - `extent.temporal.interval` (date field)
+> - `temporal` (alias to extent.temporal.interval)
 >
 > Text fields like `title` and `description` are not sortable by default as they use text analysis for better search capabilities. Attempting to sort on these fields will result in a user-friendly error message explaining which fields are sortable and how to make additional fields sortable by updating the mappings.
+>
+> **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.
 
 ## Package Structure
 

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/database_logic.py

@@ -191,7 +191,7 @@ async def get_all_collections(
             HTTPException: If sorting is requested on a field that is not sortable.
         """
         # Define sortable fields based on the ES_COLLECTIONS_MAPPINGS
-        sortable_fields = ["id", "extent.temporal.interval"]
+        sortable_fields = ["id", "extent.temporal.interval", "temporal"]
 
         # Format the sort parameter
         formatted_sort = []
@@ -206,15 +206,13 @@ async def get_all_collections(
                             status_code=400,
                             detail=f"Field '{field}' is not sortable. Sortable fields are: {', '.join(sortable_fields)}. "
                             + "Text fields are not sortable by default in Elasticsearch. "
-                            + "To make a field sortable, update the mapping to use 'keyword' type or add a '.keyword' subfield. "
-                            + "See the ES_COLLECTIONS_MAPPINGS in mappings.py for details.",
+                            + "To make a field sortable, update the mapping to use 'keyword' type or add a '.keyword' subfield. ",
                         )
                     formatted_sort.append({field: {"order": direction}})
             # Always include id as a secondary sort to ensure consistent pagination
             if not any("id" in item for item in formatted_sort):
                 formatted_sort.append({"id": {"order": "asc"}})
         else:
-            # Use a collections-specific default sort that doesn't rely on properties.datetime
             formatted_sort = [{"id": {"order": "asc"}}]
 
         body = {

stac_fastapi/opensearch/stac_fastapi/opensearch/database_logic.py

@@ -175,7 +175,7 @@ async def get_all_collections(
             HTTPException: If sorting is requested on a field that is not sortable.
         """
         # Define sortable fields based on the ES_COLLECTIONS_MAPPINGS
-        sortable_fields = ["id", "extent.temporal.interval"]
+        sortable_fields = ["id", "extent.temporal.interval", "temporal"]
 
         # Format the sort parameter
         formatted_sort = []
@@ -190,15 +190,13 @@ async def get_all_collections(
                             status_code=400,
                             detail=f"Field '{field}' is not sortable. Sortable fields are: {', '.join(sortable_fields)}. "
                             + "Text fields are not sortable by default in OpenSearch. "
-                            + "To make a field sortable, update the mapping to use 'keyword' type or add a '.keyword' subfield. "
-                            + "See the ES_COLLECTIONS_MAPPINGS in mappings.py for details.",
+                            + "To make a field sortable, update the mapping to use 'keyword' type or add a '.keyword' subfield. ",
                         )
                     formatted_sort.append({field: {"order": direction}})
             # Always include id as a secondary sort to ensure consistent pagination
             if not any("id" in item for item in formatted_sort):
                 formatted_sort.append({"id": {"order": "asc"}})
         else:
-            # Use a collections-specific default sort that doesn't rely on properties.datetime
             formatted_sort = [{"id": {"order": "asc"}}]
 
         body = {

stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/mappings.py

@@ -165,6 +165,8 @@ class Geometry(Protocol):  # noqa
         "providers": {"type": "object", "enabled": False},
         "links": {"type": "object", "enabled": False},
         "item_assets": {"type": "object", "enabled": get_bool_env("STAC_INDEX_ASSETS")},
+        # Field alias to allow sorting on 'temporal' (points to extent.temporal.interval)
+        "temporal": {"type": "alias", "path": "extent.temporal.interval"},
     },
 }