Skip to content

Commit 2f931b9

Browse files
authored
Update STAC references and deprecate v0.9.0 #543 (#569)
1 parent 96609f0 commit 2f931b9

File tree

2 files changed

+27
-22
lines changed

2 files changed

+27
-22
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616
- Added `queued`, `started` and `unpublished` to the batch job metadata and the corresponding STAC results [#542](https://github.com/Open-EO/openeo-api/issues/542)
1717
- Added all the batch job timestamps (including the new timestamps above) to the Collection type of batch job results
1818

19+
### Deprecated
20+
21+
- STAC 0.9.x
22+
1923
### Changed
2024

25+
- `GET /`: Requires the fields `type` and `conformsTo`
2126
- `GET /udf_runtimes`: Requires at least one UDF runtime to be provided. [#511](https://github.com/Open-EO/openeo-api/issues/511)
2227

2328
### Fixed

openapi.yaml

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -510,30 +510,35 @@ tags:
510510
511511
## STAC
512512
513-
For data discovery of Earth Observation Collections at the back-ends, openEO strives for compatibility with the specifications [SpatioTemporal Asset Catalog (STAC)](https://stacspec.org/) and [OGC API - Features - Part 1: Core](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) as far as possible. Implementing the data discovery endpoints of openEO also produced valid STAC API 1.0 and OGC API - Features 1.0 responses, including ([partial](#provide-data-for-download)) compatibility with their APIs.
513+
For data discovery of Earth Observation Collections at the back-ends, openEO strives for compatibility with the specifications [SpatioTemporal Asset Catalog (STAC)](https://stacspec.org/) and [OGC API - Features - Part 1: Core](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) as far as possible. Implementing the data discovery endpoints of openEO also produces valid STAC API 1.x and OGC API - Features 1.x responses, including ([partial](#provide-data-for-download)) compatibility with their APIs.
514514
515515
The data discovery endpoints `GET /collections` and `GET /collections/{collection_id}` are compatible with OGC API - Features and STAC. Both specifications define additional endpoints that need to be implemented to be fully compatible. The additional endpoints can easily be integrated into an openEO API implementation. A rough list of actions for compatibility is available below, but please refer to their specifications to find out the full details.
516516
517-
**Important:** [STAC specification](https://github.com/radiantearth/stac-spec) and [STAC API](https://github.com/radiantearth/stac-api-spec) are different specifications and have different version numbers after version 0.9.0.
518-
The openEO API implements STAC API versions >= 0.9.0 (preferrably [STAC API version 1.0.0](https://github.com/radiantearth/stac-api-spec/blob/v1.0.0/README.md), but [0.9.0](https://github.com/radiantearth/stac-spec/blob/v0.9.0/api-spec/README.md) is allowed for backward compatibility), which allows to serve all STAC specification versions in the range of 0.9.x and 1.x.x (see the `stac_version` property).
517+
**Important:** [STAC specification](https://github.com/radiantearth/stac-spec) and [STAC API](https://github.com/radiantearth/stac-api-spec) are different specifications and have different version numbers.
518+
519+
The openEO API allows for the
520+
- STAC versions 1.x.x (RECOMMENDED) and 0.9.x (DEPRECATED), and
521+
- STAC API versions 1.x.x (RECOMMENDED) and 0.9.x (DEPRECATED).
519522
520523
### Content Extensions
521524
522525
STAC has several [extensions](https://stac-extensions.github.io) that can be used to better describe your data. Clients and server are not required to implement all of them, so be aware that some clients may not be able to read all your metadata.
523526
524527
Some commonly used extensions that are relevant for datasets exposed through the openEO API are:
525-
526-
- Data Cube extension (part of the openEO API)
528+
529+
- [Classification extension](https://github.com/stac-extensions/classification)
530+
- [Data Cube extension](https://github.com/stac-extensions/datacube) (part of the openEO API)
527531
- [EO (Electro-Optical) extension](https://github.com/stac-extensions/eo)
528532
- [Processing extension](https://github.com/stac-extensions/processing)
533+
- [Projection extension](https://github.com/stac-extensions/projection)
529534
- [Raster extension](https://github.com/stac-extensions/raster)
530535
- [SAR extension](https://github.com/stac-extensions/sar)
531536
- [Satellite extension](https://github.com/stac-extensions/sat)
532537
- [Scientific Citation extension](https://github.com/stac-extensions/scientific)
533538
534539
### Provide data for download
535540
536-
If you'd like to provide your data for download in addition to offering the cloud processing service, you can implement the full STAC API. Therefore, you can implement the endpoints `GET /collections/{collection_id}/items` and `GET /collections/{collection_id}/items/{feature_id}` to support retrieval of individual items. To benefit from the STAC ecosystem and allow searching for items you can also implement `POST /search` and `GET /search`. Further information can be found in the [STAC API repository](https://github.com/radiantearth/stac-spec/tree/v0.9.0/api-spec).
541+
If you'd like to provide your data for download in addition to offering the cloud processing service, you can implement the full STAC API. Therefore, you can implement the endpoints `GET /collections/{collection_id}/items` and `GET /collections/{collection_id}/items/{feature_id}` to support retrieval of individual items. To benefit from the STAC ecosystem and allow searching for items you can also implement `POST /search` and `GET /search`. Further information can be found in the [STAC API repository](https://github.com/radiantearth/stac-api-spec).
537542
538543
### API Extensions
539544
@@ -609,6 +614,8 @@ paths:
609614
- api_version
610615
- backend_version
611616
- stac_version
617+
- conformsTo
618+
- type
612619
- endpoints
613620
- links
614621
properties:
@@ -633,8 +640,6 @@ paths:
633640
type: string
634641
enum:
635642
- Catalog
636-
description: >-
637-
For STAC versions >= 1.0.0-rc.1 this field is required.
638643
example: Catalog
639644
id:
640645
type: string
@@ -1232,7 +1237,7 @@ paths:
12321237
To get the full metadata for a collection clients MUST
12331238
request `GET /collections/{collection_id}`.
12341239
1235-
This endpoint is compatible with [STAC API 0.9.0 and later](https://stacspec.org) and
1240+
This endpoint is compatible with [STAC API 1.0.0 and later](https://stacspec.org) and
12361241
[OGC API - Features 1.0](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html).
12371242
[STAC API extensions](https://stac-api-extensions.github.io) and
12381243
[STAC extensions](https://stac-extensions.github.io)
@@ -1362,7 +1367,7 @@ paths:
13621367
Lists **all** information about a specific collection specified by the
13631368
identifier `collection_id`.
13641369
1365-
This endpoint is compatible with [STAC API 0.9.0 and later](https://stacspec.org) and
1370+
This endpoint is compatible with [STAC API 1.0.0 and later](https://stacspec.org) and
13661371
[OGC API - Features 1.0](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html).
13671372
[STAC API extensions](https://stac-api-extensions.github.io) and
13681373
[STAC extensions](https://stac-extensions.github.io)
@@ -3762,8 +3767,6 @@ components:
37623767
37633768
The general openEO conformance class is `https://api.openeo.org/1.2.0`.
37643769
See the individual openEO API extensions for their conformance classes.
3765-
3766-
This property is REQUIRED for STAC API versions 1.0.0-beta.1 and later.
37673770
type: array
37683771
items:
37693772
type: string
@@ -4544,9 +4547,9 @@ components:
45444547
45454548
Potential fields for the summaries can be found here:
45464549
4547-
* **[STAC Common Metadata](https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/common-metadata.md)**:
4550+
* **[STAC Common Metadata](https://github.com/radiantearth/stac-spec/blob/v1.1.0/commons/common-metadata.md)**:
45484551
A list of commonly used fields throughout all domains
4549-
* **[Content Extensions](https://github.com/radiantearth/stac-spec/blob/v1.0.0/extensions/README.md#list-of-content-extensions)**:
4552+
* **[Content Extensions](https://stac-extensions.github.io)**:
45504553
Domain-specific fields for domains such as EO, SAR and point clouds.
45514554
* **Custom Properties**:
45524555
It is generally allowed to add custom fields.
@@ -4564,33 +4567,30 @@ components:
45644567
Dictionary of asset objects for data that can be downloaded,
45654568
each with a unique key.
45664569
The keys MAY be used by clients as file names.
4567-
4568-
Implementing this property REQUIRES to add `collection-assets`
4569-
to the list of `stac_extensions` in STAC < 1.0.0-rc.1.
45704570
allOf:
45714571
- $ref: '#/components/schemas/stac_assets'
45724572
stac_version:
45734573
type: string
45744574
description: >-
45754575
The [version of the STAC specification](https://github.com/radiantearth/stac-spec/releases),
45764576
which MAY not be equal to the [STAC API version](#tag/EO-Data-Discovery/STAC).
4577-
Supports versions 0.9.x and 1.x.x.
4577+
4578+
The openEO API allows for the STAC versions 1.x.x (RECOMMENDED) and 0.9.x (DEPRECATED).
45784579
pattern: '^(0\.9.\d+|1\.\d+.\d+)'
4579-
example: 1.0.0
4580+
example: 1.1.0
45804581
stac_extensions:
45814582
type: array
45824583
description: >-
45834584
A list of implemented STAC extensions. The list contains URLs to the
4584-
JSON Schema files it can be validated against. For STAC < 1.0.0-rc.1
4585-
shortcuts such as `sar` can be used instead of the schema URL.
4585+
JSON Schema files it can be validated against.
45864586
uniqueItems: true
45874587
items:
45884588
anyOf:
45894589
- title: Reference to a JSON Schema
45904590
type: string
45914591
format: uri
45924592
example: 'https://openeo.example/stac/custom-extemsion/v1.0.0/schema.json'
4593-
- title: Reference to a core extension (STAC < 1.0.0-rc.1 only)
4593+
- title: Reference to a core extension (STAC < 1.0.0-rc.1 only, DEPRECATED)
45944594
type: string
45954595
example: datacube
45964596
stac_license:

0 commit comments

Comments
 (0)