Release openEO API v1.1.0

m-mohr commented 3 years ago

Background

We've collected improvements and useful new features over half a year, especially for openEO Platform. This publishes clarifications and improvements to the public so that we don't need to work on the draft for too long. This API release is also required to be able to release openEO processes in the next months due to the first bullet point in the section "Added". Additionally, it may be good to show some progress after the end of the H2020 project.

Most back-ends can likely just increase the version number to 1.1.0, except for potentially some minor changes that may originate from some clarifications. The clients may want to consider implementing the "breaking" change mentioned below.

You can review the changes at https://github.com/Open-EO/openeo-api/pull/391.

The following changes have been made to the API:

Added

GET /processes and GET / PUT for /process_graphs/{process_graph_id}: Allow specifying the return values processes receive from child processes. #350
Recommendation that POST /result returns a tar file if the result consists of multiple files. #349
GET /credentials/oidc can provide a set of default client ids for OpenID Connect. #366
experimental and deprecated flags added for file formats, service types, udf runtimes, udf runtime versions, udf runtime libraries and all related parameters and schemas. #354
GET /jobs/{job_id} and GET /services/{service_id}: usage property added for usage metrics. #370
GET /jobs/{job_id}/logs and GET /services/{service_id}/logs:
- time property added. #330
- usage property added to log entries. #370
Added error ResultLinkExpired. #379
GET /me: A default plan per user can be specified. #375

Changed

API doesn't discourage usage of multipleOf in JSON Schemas any longer.
GET /jobs/{job_id}/results supports to return a STAC Collection. #343 - potentially breaking change for clients, we agreed to include it in a minor release in PSC vote #10
Updated STAC schemas to better support versions 1.x.x.
The first extent in a Collection is always the overall extent, followed by more specific extents. #369 - a change inherited from STAC and OGC APIs

Fixed

Clarified how process exceptions should be used. #352
Clarified that job results schould be stored as valid STAC catalogs. #363
Clarified that job results require the property datetime and allow for additional properties. #362
Clarified that billing plans, service names and file formats must be accepted case-insensitive. #371
Clarified that the first provider listed at GET /credentials/oidc is the default provider for OpenID Connect.
Clarified that GET /jobs/{job_id}/results should always return valid signed URLs and the endpoint can be used to renew the signed URLs. #379
Fixed casing of potential endpoints GET /collections/{collection_id}/items and GET /collections/{collection_id}/items/{feature_id}.
Clarified allowed characters in the path for uploaded user files.

Proposal

I'm proposing to release openEO API 1.1.0 in May or June (the target date in the changelog right now is June 15th, 2021). I'll inform you here if any additional changes come in until we approved the release here.