Skip to content

openEO API v1.0.0
Compare
Choose a tag to compare
@m-mohr m-mohr released this 17 Jul 12:17
· 203 commits to master since this release
1.0.0
293b67c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

First stable release!

Documentation: https://api.openeo.org/1.0.0/

1.0.0 - 2020-07-17

Added

  • GET /me: Added optional name property to better separate an internal user id from a displayable user name. Adopted description of user_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.
  • GET /service_types: Added optional title and description properties for service types. #266
  • GET /file_formats: Added optional description property for file formats. #266
  • GET /collections/{collection_id} and GET /processes: Mention of link rel type example to refer to examples. #285
  • GET /collections/{collection_id}: Added optional assets property for collection-level assets. This may link to visualizations for example. #211
  • GET /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: field scopes is not required anymore, but when specified, it should contain the openid scope. #288
  • GET /.well-known/openeo and GET /: production fields default to false instead of true.
  • GET /jobs/{job_id}/logs and GET /services/{service_id}/logs: path property is not required any longer. #320
  • GET /file_formats: parameters is now required for each file format. #318
  • GET /service_types: configuration and process_parameters are now required for each service. #318
  • GET /service_types and GET /file_formats:
    • Allow full JSON Schema for parameters, instead of a very limited subset.
    • Instead of the proprietary property example use examples from JSON Schema instead.
  • GET /collections and GET /collections/{collection_id}:
    • Additional dimensions in cube:dimensions can only be of type other.
    • The extents interval and bbox can have multiple entries.
  • 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 and PredefinedProcessExists.
    • Added variable reason to error FilePathInvalid and type to FileTypeInvalid andServiceUnsupported.
    • Replaced the following error messages. The variables in the messages may have changed, too.
      • ProcessArgumentUnsupported -> ProcessParameterUnsupported
      • ProcessArgumentInvalid -> ProcessParameterInvalid
      • ProcessParameterMissing and ProcessArgumentRequired -> 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 as exceptions.

Removed

  • GET /processes: Examples containing process graphs. Use links with rel type example and type set to application/json instead. #285
  • subtype-schemas.json. It's now published as part of openeo-processes.

Fixed

  • /.well-known/openeo:
    • Clarified that version numbers must be unique. #287
    • Clarified that non-production ready versions should be connected to if no production-ready version is supported. #289
  • GET /jobs/{job_id}/results: Clarified that unlocated results set geometry to null and omit the bbox property.
  • GET /jobs/{job_id}/logs: Clarified that back-ends can log at any stage of the job. #315
  • POST /jobs and POST /services: Clarified definition of Location header in HTTP 201 responses. #269
  • GET /service/{service_id}: Property configuration is required instead of a non-existing property named parameters.
  • 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 (adds pattern).
  • 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.
Assets 2
Loading