openEO API v1.0.0
First stable release!
Documentation: https://api.openeo.org/1.0.0/
1.0.0 - 2020-07-17
Added
GET /me
: Added optionalname
property to better separate an internal user id from a displayable user name. Adopted description ofuser_id
accordingly.GET /udf_runtimes
:- Added optional
title
property for UDF runtimes. #266 - Added required
type
property for UDF runtimes to support better code generation.
- Added optional
GET /service_types
: Added optionaltitle
anddescription
properties for service types. #266GET /file_formats
: Added optionaldescription
property for file formats. #266GET /collections/{collection_id}
andGET /processes
: Mention of linkrel
typeexample
to refer to examples. #285GET /collections/{collection_id}
: Added optionalassets
property for collection-level assets. This may link to visualizations for example. #211GET /collections
,GET /jobs
,GET /process_graphs
,GET /services
: Allow all non-scalar properties to be part of the response although strongly discouraged.
Changed
GET /credentials/oidc
: fieldscopes
is not required anymore, but when specified, it should contain theopenid
scope. #288GET /.well-known/openeo
andGET /
:production
fields default tofalse
instead oftrue
.GET /jobs/{job_id}/logs
andGET /services/{service_id}/logs
:path
property is not required any longer. #320GET /file_formats
:parameters
is now required for each file format. #318GET /service_types
:configuration
andprocess_parameters
are now required for each service. #318GET /service_types
andGET /file_formats
:- Allow full JSON Schema for parameters, instead of a very limited subset.
- Instead of the proprietary property
example
useexamples
from JSON Schema instead.
GET /collections
andGET /collections/{collection_id}
:- Additional dimensions in
cube:dimensions
can only be of typeother
. - The extents
interval
andbbox
can have multiple entries.
- Additional dimensions in
- Allow all STAC versions that are compatible to STAC 0.9.0.
- Process graph nodes have an additional field
namespace
to distinguish pre-defined and user-defined processes. The default behavior has not changed. #305 - Added
format: commonmark
to all properties supporting CommonMark formatting. errors.json
: The pre-defined error messages have been reworked. #272, #273- Added
FolderOperationUnsupported
,UnsupportedApiVersion
,PermissionsInsufficient
,ProcessGraphIdDoesntMatch
andPredefinedProcessExists
. - Added variable
reason
to errorFilePathInvalid
andtype
toFileTypeInvalid
andServiceUnsupported
. - Replaced the following error messages. The variables in the messages may have changed, too.
ProcessArgumentUnsupported
->ProcessParameterUnsupported
ProcessArgumentInvalid
->ProcessParameterInvalid
ProcessParameterMissing
andProcessArgumentRequired
->ProcessParameterRequired
ServiceArgumentUnsupported
->ServiceConfigUnsupported
ServiceArgumentInvalid
->ServiceConfigInvalid
ServiceArgumentRequired
->ServiceConfigRequired
- Removed all error messages with tag
Processes
(CRSInvalid
,CoordinateOutOfBounds
) or related to storing file formats (FormatUnsupported
,FormatArgumentUnsupported
,FormatArgumentInvalid
,FormatUnsuitable
) as they are usually defined directly in the process specification asexceptions
.
- Added
Removed
GET /processes
: Examples containing process graphs. Use links withrel
typeexample
andtype
set toapplication/json
instead. #285subtype-schemas.json
. It's now published as part of openeo-processes.
Fixed
/.well-known/openeo
:GET /jobs/{job_id}/results
: Clarified that unlocated results setgeometry
tonull
and omit thebbox
property.GET /jobs/{job_id}/logs
: Clarified that back-ends can log at any stage of the job. #315POST /jobs
andPOST /services
: Clarified definition ofLocation
header inHTTP 201
responses. #269GET /service/{service_id}
: Propertyconfiguration
is required instead of a non-existing property namedparameters
.POST /validation
: Clarify that unresolvable process parameters must not throw. #314- Formally forbid 5 elements in bounding boxes.
- Re-use corresponding schema for header
OpenEO-Identifier
(addspattern
). - Parameters passed to child process graphs are not defined recursively any longer. #268
- Parameters for child process graphs are not specified for return values and service type parameters any longer. #268
- Clarified the expected behavior for process parameters, if a default value is given and the parameter is implicitly set to be required. #303
- Several clarifications and improvements for the documentation.