Explicitly specify metadata filters for collections #396

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `create-form` to link to the registration page
   - `recovery-form` to link to the credentials recovery page.
 - `GET /me`: New Relation types `alternate` and `related` for user-specific external pages. [#404](https://github.com/Open-EO/openeo-api/issues/404)
+- `GET /collections` and `GET /collections/{collection_id}` (and implicitly `GET /jobs/{job_id}/results`): Added a field that can indicate which properties can be filtered on when loading data from a collection. [#396](https://github.com/Open-EO/openeo-api/issues/396)
 - `GET /credentials/oidc`: Allow `authorization_code` and `urn:ietf:params:oauth:grant-type:device_code` (both without PKCE) as grants for `default_clients`. [#410](https://github.com/Open-EO/openeo-api/issues/410)
 - Recommendation to add media types and titles to links for a better user experience.
 - Allow the relation type `canonical` to be used generally for (shared) resources (e.g. UDPs or batch jobs) without requiring Bearer authentication. [#405](https://github.com/Open-EO/openeo-api/issues/405)

openapi.yaml

@@ -1445,6 +1445,10 @@ paths:
                       - B10
                       - B11
                       - B12
+                'openeo:property_filters':
+                  - platform
+                  - eo:cloud_cover
+                  - sat:orbit_state
                 summaries:
                   'constellation':
                     - Sentinel-2
@@ -4346,6 +4350,21 @@ components:
             x-additionalPropertiesName: Dimension Name
             allOf:
               - $ref: '#/components/schemas/dimension'
+        'openeo:property_filters':
+          description: |-
+            Gives a list of properties you can filter on when loading data from the collection.
+            Returning an empty array means that no filters are available.
+
+            This is a guide for users to get an overview over available filters.
+            More metadata about the properties can be found in `summaries`.
+
+            If this property is not present, it means that the collections does 
+            not provide any collection-specific details about available filters. 
+            It's then up to other means of documentation to inform the user,
+            e.g. there could be documentation about filters that work across collections.
+          type: array
+          items:
+            type: string
         summaries:
           title: STAC Summaries (Collection Properties)
           description: |-