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.
The openEO (core) API is currently released in version 0.4.2.
Note: The specification is currently still an early version, with the potential for some major things to change. The core is now fleshed out, so implementors are encouraged to try it out and give feedback. But the goal is to actually be able to act on that feedback, which will mean changes are quite possible. A solid basis is specified right now, but best practices, extensions and specification details will emerge with implementation.
| Version / Branch | Status | Description |
|---|---|---|
| 0.0.1 (Spec) | legacy | First draft with basic ideas, loosely implemented. |
| 0.0.2 (Spec) | legacy | Proof of concept, implemented. |
| 0.3.0 (Spec) | legacy | Major rework. |
| 0.3.1 (Spec) | legacy | Fixing minor issues, see the changelog. |
| 0.4.0 (Spec) | legacy | Improved discovery, added processes catalogue, new process graph structure and more. |
| 0.4.1 (Spec) | legacy | Bugfix release, see the changelog. |
| 0.4.2 (Spec) | current | Bugfix release, see the changelog. |
| draft (Spec) | planned | Improvements based on implementer feedback, introduce extension concept. Potentially version 1.0.0. |
See also the changelog and the milestones for a rough roadmap based on GitHub issues.
This repository contains a set of files formally and technically describing the openEO API, each with a human-readable and easily browseable version:
- docs/ (browseable version) contains all additional written documentation, including 'getting started' guides, the architecture, feature descriptions, development guidelines and more.
- processes/ (browseable version) defines pre-defined core processes back-ends may implement for best interoperability.
- openapi.json (browseable version) provides the openAPI 3.0 definition of the openEO API.
- subscriptions.json (browseable version) provides the AsyncAPI 1.2 definitions for the WebSocket-based subscriptions and notifications API for openEO.
- errors.json (browseable version) is a list of potential global error codes and messages, excluding specific exceptions separately available for each process.