Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 5.18 KB

README.md

File metadata and controls

56 lines (41 loc) · 5.18 KB
Raw

openEO API

openEO develops an open API to connect R, Python and JavaScript clients to big Earth observation cloud back-ends in a simple and unified way. This repository contains this API, the openEO (core) API.

Versions / Branches

The master branch is the 'stable' version of the openEO API specification. It is currently version 1.2.0 of the specification. The draft branch is where active development takes place.

Version / Branch Status Description
draft planned Unstable - Next version.
1.2.0 current Clarifications, new extensions, vector data cubes, STAC (API) updates, more link relation types, improved batch job results and logs. Changelog.
1.1.0 legacy Clarifications, STAC updates, return value for child processes, more details for logs and jobs, default clients for OIDC. Changelog.
1.0.1 legacy Clarifications, bugfixes and CORS improvements. Changelog.
1.0.0 legacy First stable version of openEO. Changelog.
1.0.0-rc.2 legacy Introduced user-defined processes. Changelog.
1.0.0-rc.1 legacy Better UDF support, support for file import, support for processing logs, better alignment with STAC and upcoming OGC APIs. Removes WebSocket-based Subscription API. Changelog
0.4.2 legacy Bugfix release. Changelog.
0.4.1 legacy Bugfix release. Changelog.
0.4.0 legacy Improved discovery, added processes catalogue, new process graph structure. Changelog.
0.3.1 legacy Bugfix release. Changelog.
0.3.0 legacy Major rework.
0.0.2 legacy Proof of concept, implemented.
0.0.1 legacy First draft with basic ideas, loosely implemented.

See also the changelog and the milestones for a rough roadmap based on GitHub issues.

Extensions

Name Version Stability Description
Commercial Data 0.1.0 experimental Provides an interface for discovering, ordering and using commercial data.
Federation 0.1.0 experimental Covers federation aspects, i.e. where multiple back-ends are exposed as a single API.

Repository

This repository contains a set of files formally describing the openEO API, each with a human-readable and easily browseable version:

  • openapi.yaml provides the OpenAPI 3.0 definition of the openEO API. See the table above for human-readable versions of the OpenAPI definition.
  • errors.json is a list of potential global error codes and messages, excluding specific exceptions separately available for each process.
  • The assets folder contains some useful additional files such as examples or schemas. All of these are non-binding additions. The source of truth are the top-level specification files.
  • The extensions folder contains extensions to the openEO API.

Development

The draft branch is the latest version and is the one to create Pull Requests against.

For development some tools can be used:

  1. Install node and npm - should run with any recent version
  2. Run npm install in this folder to install the dependencies
  3. Run the linter for the OpenAPI file with npm test. This will lint the files and check against some best-practices. It uses spectral in the background.
  4. To show the files nicely formatted in a web browser, run npm start. It starts a server and opens the API specification rendered with ReDoc in a web browser.
  5. To create a static HTML page (e.g. for hosting it on GitHub Pages), you can run npm run build and it will create a redoc.html in this folder.