eodag 2.12.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

eodag/resources/stac.yml

@@ -17,63 +17,88 @@
 # limitations under the License.
 
 stac_version: 1.0.0
-stac_api_version: 1.0.0-rc.3
+stac_api_version: 1.0.0
 
 # Capabilities ----------------------------------------------------------------
 
 # https://stacspec.org/STAC-api.html#operation/getLandingPage
 landing_page:
-  title: "EODAG"
   type: "Catalog"
-  description: "STAC API provided by EODAG"
   links:
     - rel: self
       type: "application/json"
       href: "{catalog[root]}/"
     - rel: service-desc
       type: "application/vnd.oai.openapi+json;version=3.0"
+      title: "OpenAPI service description"
       href: "{catalog[root]}/api"
     - rel: service-doc
       type: "text/html"
+      title: "OpenAPI service documentation"
       href: "{catalog[root]}/api.html"
     - rel: conformance
       type: "application/json"
+      title: "STAC/WFS3 conformance classes implemented by this server"
       href: "{catalog[root]}/conformance"
     - rel: data
       type: "application/json"
       href: "{catalog[root]}/collections"
     - rel: search
+      type: "application/geo+json"
+      title: "STAC search"
       href: "{catalog[root]}/search"
       method: GET
+    - rel: search
+      type: "application/geo+json"
+      title: "STAC search"
+      href: "{catalog[root]}/search"
+      method: POST
   stac_version: "{stac_version}"
-  id: eodag-stac-api
   conformsTo: "{conformance[conformsTo]}"
 
 # required by OGC API - Features
 # http://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_declaration_of_conformance_classes
 conformance:
   conformsTo:
-    - https://api.stacspec.org/v1.0.0-rc.3/core
-    - https://api.stacspec.org/v1.0.0-rc.3/item-search
-    - https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features
-    - https://api.stacspec.org/v1.0.0-rc.3/collections
+    - https://api.stacspec.org/v1.0.0/core
+    - https://api.stacspec.org/v1.0.0/item-search
+    - https://api.stacspec.org/v1.0.0/item-search#query
+    - https://api.stacspec.org/v1.0.0/item-search#filter
+    - https://api.stacspec.org/v1.0.0/item-search#sort
+    - https://api.stacspec.org/v1.0.0/ogcapi-features
+    - https://api.stacspec.org/v1.0.0/ogcapi-features#query
+    - https://api.stacspec.org/v1.0.0/ogcapi-features#sort
+    - https://api.stacspec.org/v1.0.0/collections
+    - https://api.stacspec.org/v1.0.0/collection-search
+    - https://api.stacspec.org/v1.0.0/collection-search#free-text
+    - https://api.stacspec.org/v1.0.0/collection-search#advanced-free-text
+    - http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query
     - http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core
     - http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30
     - http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson
+    - http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter
+    - http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter
+    - http://www.opengis.net/spec/cql2/1.0/conf/cql2-text
+    - http://www.opengis.net/spec/cql2/1.0/conf/cql2-json
+    - http://www.opengis.net/spec/cql2/1.0/conf/basic-cql2
+    - http://www.opengis.net/spec/cql2/1.0/conf/basic-spatial-operators
+    - http://www.opengis.net/spec/cql2/1.0/conf/temporal-operators
+    - http://www.opengis.net/spec/cql2/1.0/conf/advanced-comparison-operators
 
 # https://stacspec.org/STAC-api.html#operation/getCollections
 collections:
+  collections:
+    - "{collection}"
   links:
-    - rel: self
-      title: collections
-      href: "{collections[url]}"
     - rel: root
+      type: "application/json"
       href: "{collections[root]}/"
     - rel: parent
+      type: "application/json"
       href: "{collections[root]}/"
-  collections:
-    - "{collection}"
-  stac_version: "{stac_version}"
+    - rel: self
+      type: "application/json"
+      href: "{collections[url]}"
 
 # https://stacspec.org/STAC-api.html#operation/describeCollection
 collection:
@@ -101,7 +126,6 @@ collection:
       interval:
         - - '$.product_type.missionStartDate'
           - '$.product_type.missionEndDate'
-  properties:
   crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
   stac_version: "{stac_version}"
   keywords:
@@ -119,15 +143,8 @@ collection:
       - '$.product_type.platformSerialIdentifier'
     intruments:
       - '$.product_type.instrument'
-    processing:level: '$.product_type.processingLevel'
-
-provider:
-  name: '$.provider.name'
-  description: '$.provider.description'
-  # one or more of "producer" "licensor" "processor" "host"
-  roles: '$.provider.roles'
-  url: '$.provider.url'
-  priority: '$.provider.priority'
+    processing:level:
+      - '$.product_type.processingLevel'
 
 # Data ------------------------------------------------------------------------
 
@@ -147,26 +164,18 @@ items:
     - rel: parent
       title: "{catalog[id]}"
       href: "{catalog[url]}"
-    # implement next/prev page links
-    # https://github.com/radiantearth/stac-spec/blob/master/api-spec/api-spec.md#paging-extension
-    - rel: next
-      href: '$.search_results.next'
-      title: Next page
-      type: application/geo+json
-      method: '$.search_results.method'
-      body: '$.search_results.body'
   # time and date when the response was generated
-  timeStamp: '$.search_results.timeStamp'
+  timeStamp: '$.timeStamp'
   # count request result
-  numberMatched: '$.search_results.numberMatched'
+  numberMatched: '$.numberMatched'
   # len(features)
-  numberReturned: '$.search_results.numberReturned'
+  numberReturned: '$.numberReturned'
 
 # https://stacspec.org/STAC-api.html#operation/getFeature
 item:
   stac_version: "{stac_version}"
   stac_extensions:
-  id: '$.product.properties.title'
+  id: '$.product.properties.id'
   bbox:
     - '{item[geometry].bounds[0]}'
     - '{item[geometry].bounds[1]}'
@@ -204,6 +213,7 @@ item:
     version: '$.product.properties.productVersion'
     view:sun_elevation: '$.product.properties.illuminationElevationAngle'
     view:sun_azimuth: '$.product.properties.illuminationAzimuthAngle'
+    order:status: '{$.product.properties.storageStatus#get_group_name((?P<succeeded>ONLINE)|(?P<shipping>STAGING)|(?P<orderable>OFFLINE))}'
   links:
     - rel: self
       title: "{item[id]}"
@@ -216,20 +226,7 @@ item:
     - rel: collection
       title: "{item[collection]}"
       href: "{catalog[url]}"
-  assets:
-    downloadLink:
-        title: 'Download link'
-        href: "{catalog[url]}/items/{item[id]}/download"
-        # https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#media-types
-        type: 'application/zip'
-        _dc_qs: '$.product.properties._dc_qs'
-    thumbnail:
-        title: 'Thumbnail'
-        href: '$.product.properties.quicklook'
-        type: 'image/jpeg'
-        role: thumbnail
-        # https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#media-types
-    origin_assets: '$.product.assets'
+
 # product properties not needed in items
 metadata_ignore:
   - title
@@ -242,16 +239,18 @@ metadata_ignore:
 # extensions mapping {prefix: schema_url,}
 stac_extensions:
   eo: 'https://stac-extensions.github.io/eo/v1.0.0/schema.json'
+  order: 'https://stac-extensions.github.io/order/v1.1.0/schema.json'
   published: 'https://stac-extensions.github.io/timestamps/v1.0.0/schema.json'
   processing: 'https://stac-extensions.github.io/processing/v1.0.0/schema.json'
   sar: 'https://stac-extensions.github.io/sar/v1.0.0/schema.json'
   sat: 'https://stac-extensions.github.io/sat/v1.0.0/schema.json'
+  storage: 'https://stac-extensions.github.io/storage/v1.0.0/schema.json'
   sci: 'https://stac-extensions.github.io/scientific/v1.0.0/schema.json'
   version: 'https://stac-extensions.github.io/version/v1.0.0/schema.json'
   view: 'https://stac-extensions.github.io/view/v1.0.0/schema.json'
   oseo: "{catalog[root]}/extensions/oseo/json-schema/schema.json"
 
-# Catalogs --------------------------------------------------------------------
+# Catalog --------------------------------------------------------------------
 
 catalog:
   parent_key: root
@@ -268,171 +267,6 @@ catalog:
     stac_version: "{stac_version}"
     stac_extensions: "{catalog[stac_extensions]}"
 
-
-# nested catalogs for filtering
-catalogs:
-
-  product_types_list:
-    parent_key: root
-    child_key: product_type
-    model:
-      id: "product_types"
-      description: Available product types
-
-  product_type:
-    parent_key: product_types_list
-    model:
-      id: "{collection[id]}"
-      title: "{collection[title]}"
-      description: "{collection[description]}"
-      extent:
-        spatial:
-          bbox:
-            - - "{collection[extent][spatial][bbox][0][0]}"
-              - "{collection[extent][spatial][bbox][0][1]}"
-              - "{collection[extent][spatial][bbox][0][2]}"
-              - "{collection[extent][spatial][bbox][0][3]}"
-        temporal:
-          interval:
-            - - "{collection[extent][temporal][interval][0][0]}"
-              - "{collection[extent][temporal][interval][0][1]}"
-      crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
-      keywords:
-        - "{collection[keywords][0]}"
-        - "{collection[keywords][1]}"
-        - "{collection[keywords][2]}"
-        - "{collection[keywords][3]}"
-        - "{collection[keywords][4]}"
-      license: "{collection[license]}"
-      properties: "{collection[properties]}"
-      providers: "{collection[providers]}"
-      summaries: "{collection[summaries]}"
-
-  years_list:
-    child_key: year
-    model:
-      id: year
-      title: "{parent_catalog[title]} / year"
-      description: "{parent_catalog[description]}\n\n- Filter by year"
-
-  year:
-    parent_key: years_list
-    model:
-      id: "{date[year]}"
-      title: "{catalog[title]}: {date[year]}"
-      description: "{catalog[description]}: {date[year]};"
-      extent:
-        spatial:
-          bbox:
-            - - "{catalog[extent][spatial][bbox][0][0]}"
-              - "{catalog[extent][spatial][bbox][0][1]}"
-              - "{catalog[extent][spatial][bbox][0][2]}"
-              - "{catalog[extent][spatial][bbox][0][3]}"
-        temporal:
-          interval:
-            - - "{date[min]}"
-              - "{date[max]}"
-
-  months_list:
-    child_key: month
-    parent_key: year
-    model:
-      id: month
-      title: "{parent_catalog[title]} / month"
-      description: "{parent_catalog[description]}\n\n- Filter by month"
-
-  month:
-    parent_key: months_list
-    model:
-      id: "{date[month]}"
-      title: "{catalog[title]}: {date[month]}"
-      description: "{catalog[description]}: {date[month]};"
-      extent:
-        spatial:
-          bbox:
-            - - "{catalog[extent][spatial][bbox][0][0]}"
-              - "{catalog[extent][spatial][bbox][0][1]}"
-              - "{catalog[extent][spatial][bbox][0][2]}"
-              - "{catalog[extent][spatial][bbox][0][3]}"
-        temporal:
-          interval:
-            - - "{date[min]}"
-              - "{date[max]}"
-
-  days_list:
-    child_key: day
-    parent_key: month
-    model:
-      id: day
-      title: "{parent_catalog[title]} / day"
-      description: "{parent_catalog[description]}\n\n- Filter by day"
-
-  day:
-    parent_key: days_list
-    model:
-      id: "{date[day]}"
-      title: "{catalog[title]}: {date[day]}"
-      description: "{catalog[description]}: {date[day]};"
-      extent:
-        spatial:
-          bbox:
-            - - "{catalog[extent][spatial][bbox][0][0]}"
-              - "{catalog[extent][spatial][bbox][0][1]}"
-              - "{catalog[extent][spatial][bbox][0][2]}"
-              - "{catalog[extent][spatial][bbox][0][3]}"
-        temporal:
-          interval:
-            - - "{date[min]}"
-              - "{date[max]}"
-
-  cloud_covers_list:
-    child_key: cloud_cover
-    model:
-      id: cloud_cover
-      title: "{parent_catalog[title]} / Max cloud cover"
-      description: "{parent_catalog[description]}\n\n- Filter by maximum cloud cover %"
-
-  cloud_cover:
-    parent_key: cloud_covers_list
-    model:
-      id: "{cloud_cover}"
-      title: "{catalog[title]}: {cloud_cover}%"
-      description: "{catalog[description]}: {cloud_cover}%;"
-
-
-locations_catalogs:
-
-  locations_list:
-    catalog_type: location_list
-    child_key: "$.shp_location.name"
-    path: "$.shp_location.path"
-    attr: "$.shp_location.attr"
-    parent_key: "$.shp_location.parent.name"
-    parent:
-      key: "$.shp_location.parent.name"
-      attr: "$.shp_location.parent.attr"
-    model:
-      id: "$.shp_location.name"
-      self_title: "$.shp_location.name"
-      title: "{parent_catalog[title]} / {catalog[self_title]}"
-      description: "{parent_catalog[description]}\n\n- Filter by {catalog[self_title]}"
-
-  location:
-    catalog_type: location
-    parent_key: "{locations_list}"
-    model:
-      id: "{feature[id]}"
-      title: "{catalog[title]}: {feature[id]}"
-      description: "{catalog[description]}: {feature[id]};"
-      extent:
-        spatial:
-          bbox: '{feature[geometry]#to_bounds_lists}'
-        temporal:
-          interval:
-            - - "{catalog[extent][temporal][interval][0][0]}"
-              - "{catalog[extent][temporal][interval][0][1]}"
-
-
 # Extensions ------------------------------------------------------------------
 extensions:
   oseo:

eodag/resources/stac_api.yml

@@ -107,6 +107,7 @@ paths:
       description: |-
           Fetch features in the given catalog provided with `catalogPath`.
       parameters:
+        - $ref: '#/components/parameters/provider'
         - $ref: '#/components/parameters/catalogPath'
         - $ref: '#/components/parameters/bbox'
         - $ref: '#/components/parameters/datetime'
@@ -130,6 +131,7 @@ paths:
           Fetch the feature with id `featureId` in the given catalog provided
           with `cataloPath`.
       parameters:
+        - $ref: '#/components/parameters/provider'
         - $ref: '#/components/parameters/catalogPath'
         - $ref: '#/components/parameters/featureId'
       responses:
@@ -148,6 +150,7 @@ paths:
             Download the feature with id `featureId` in the given catalog provided
             with `catalogPath`.
         parameters:
+          - $ref: '#/components/parameters/provider'
           - $ref: '#/components/parameters/catalogPath'
           - $ref: '#/components/parameters/featureId'
         responses:
@@ -169,9 +172,14 @@ paths:
       summary: The feature collections in the dataset.
       description: A body of Feature Collections that belong or are used together with additional links. Request may not return the full set of metadata per Feature Collection.
       operationId: getCollections
+      parameters:
+        - $ref: '#/components/parameters/provider'
+        - $ref: '#/components/parameters/q'
       responses:
         '200':
           $ref: '#/components/responses/Collections'
+        '202':
+          $ref: '#/components/responses/Accepted'
         '500':
           $ref: '#/components/responses/ServerError'
   /collections/{collectionId}:
@@ -225,6 +233,7 @@ paths:
       tags:
         - Data
       parameters:
+        - $ref: '#/components/parameters/provider'
         - $ref: '#/components/parameters/collectionId'
         - $ref: '#/components/parameters/bbox'
         - $ref: '#/components/parameters/datetime'
@@ -254,6 +263,7 @@ paths:
       tags:
         - Data
       parameters:
+        - $ref: '#/components/parameters/provider'
         - $ref: '#/components/parameters/collectionId'
         - $ref: '#/components/parameters/featureId'
       summary: fetch a single feature
@@ -275,6 +285,7 @@ paths:
       tags:
         - Data
       parameters:
+        - $ref: '#/components/parameters/provider'
         - $ref: '#/components/parameters/collectionId'
         - $ref: '#/components/parameters/featureId'
       summary: download a single feature assets archive
@@ -300,24 +311,19 @@ paths:
       description: |-
         Retrieve Items matching filters. Intended as a shorthand API for simple
         queries.
-
-        This method is optional, but you MUST implement `POST /search` if you
-        want to implement this method.
-
-        If this endpoint is implemented on a server, it is required to add a
-        link referring to this endpoint with `rel` set to `search` to the
-        `links` array in `GET /`. As `GET` is the default method, the `method`
-        may not be set explicitly in the link.
       operationId: getSearchSTAC
       tags:
         - STAC
       parameters:
-      - $ref: '#/components/parameters/bbox'
-      - $ref: '#/components/parameters/datetime'
-      - $ref: '#/components/parameters/limit'
-      - $ref: '#/components/parameters/intersects'
-      - $ref: '#/components/parameters/ids'
-      - $ref: '#/components/parameters/collectionsArray'
+        - $ref: '#/components/parameters/bbox'
+        - $ref: '#/components/parameters/datetime'
+        - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/intersects'
+        - $ref: '#/components/parameters/ids'
+        - $ref: '#/components/parameters/collectionsArray'
+        - $ref: '#/components/parameters/provider'
+        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/sortby'
       responses:
         '200':
           description: A feature collection.
@@ -342,22 +348,22 @@ paths:
       description: |-
         Retrieve items matching filters. Intended as the standard, full-featured
         query API.
-
-        This method is mandatory to implement if `GET /search` is implemented.
-        If this endpoint is implemented on a server, it is required to add a
-        link referring to this endpoint with `rel` set to `search` and `method`
-        set to `POST` to the `links` array in `GET /`.
       tags:
         - STAC
       operationId: postSearchSTAC
       requestBody:
         description: |
-          The `POST /search` JSON body specification is detailed in the [STAC specification](https://api.stacspec.org/v1.0.0/item-search/)
+          The `POST /search` JSON body specification is detailed in the
+          [STAC specification](https://api.stacspec.org/v1.0.0/item-search/).
+          Both [Query](https://github.com/stac-api-extensions/query) and
+          [Filter](https://github.com/stac-api-extensions/filter) extensions are supported.
         required: true
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/searchBody'
+              allOf:
+                - $ref: '#/components/schemas/searchBody'
+                - $ref: 'https://api.stacspec.org/v1.0.0-beta.3/item-search/openapi.yaml#/components/schemas/components-schemas-searchBody'
       responses:
         '200':
           description: A feature collection.
@@ -621,6 +627,30 @@ components:
       required: false
       schema:
         type: string
+    filter:
+      name: filter
+      x-stac-api-fragment: filter
+      in: query
+      description: |-
+        A CQL filter expression for filtering items.
+      required: false
+      schema:
+        oneOf:
+          - $ref: 'https://api.stacspec.org/v1.0.0-beta.3/item-search/openapi.yaml#/components/schemas/booleanValueExpression'
+          - $ref: '#/components/schemas/filter-cql-text'
+    sortby:
+      name: sortby
+      x-stac-api-fragment: sort
+      in: query
+      description: |-
+        An array of property names, prefixed by either "+" for ascending or
+        "-" for descending. If no prefix is provided, "+" is assumed.
+      required: false
+      schema:
+        type: string
+        example: '+start_datetime'
+      style: form
+      explode: false
   schemas:
     queryProp:
       description: Apply query operations to a specific property
@@ -1125,6 +1155,10 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/link'
+    filter-cql-text:
+      description: |
+        A CQL filter expression in the 'cql-text' encoding.
+      type: string
     geometryGeoJSON:
       oneOf:
         - $ref: '#/components/schemas/pointGeoJSON'
@@ -1454,6 +1488,7 @@ components:
       description: The search criteria
       type: object
       allOf:
+        - $ref:  '#/components/schemas/providerFilter'
         - $ref: '#/components/schemas/collectionsFilter'
         - $ref: '#/components/schemas/bboxFilter'
         - $ref: '#/components/schemas/datetimeFilter'
@@ -1470,10 +1505,12 @@ components:
           - 34
         collections:
           - S2_MSI_L1C
-        platform:
-          eq: S2A
-        eo:cloud_cover:
-          lte: 80
+        query:
+          platform:
+            eq: S2A
+          eo:cloud_cover:
+            lte: 80
+        provider: peps
         limit: 10
     limit:
       type: integer
@@ -1578,6 +1615,9 @@ components:
       properties:
         collections:
           $ref: '#/components/schemas/collectionsArray'
+    providerFilter:
+      type: string
+      description: Only interrogate the specifiec provider
     queryFilter:
       description: An object representing a query filter.
       type: object
@@ -1876,6 +1916,12 @@ components:
         text/html:
           schema:
             type: string
+    Accepted:
+      description: The request has been accepted, but the data is not yet ready. Please wait a few minutes before trying again.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/exception'
     Collections:
       description: >-
         The feature collections shared by this API.

eodag/resources/stac_provider.yml

@@ -24,6 +24,11 @@ search:
     next_page_url_key_path: '$.links[?(@.rel="next")].href'
     next_page_query_obj_key_path: '$.links[?(@.rel="next")].body'
     next_page_merge_key_path: '$.links[?(@.rel="next")].merge'
+  sort:
+    sort_by_tpl: '{{"sortby": [ {{"field": "{sort_param}", "direction": "{sort_order}" }} ] }}'
+    sort_order_mapping:
+      ascending: asc
+      descending: desc
   discover_metadata:
     auto_discovery: true
     metadata_pattern: '^[a-zA-Z0-9_:-]+$'