Skip to content

Commit

Permalink
Merge pull request #136 from Open-EO/0.3.1
Browse files Browse the repository at this point in the history 
openEO API 0.3.1 - bugfix release
  • Loading branch information
@m-mohr
m-mohr authored Nov 6, 2018
2 parents 58e0832 + 06274a2 commit 616cb18
Show file tree
Hide file tree
Showing 19 changed files with 864 additions and 270 deletions.
3 changes: 3 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
__pycache__/
.vscode
site/
5 changes: 3 additions & 2 deletions .travis.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ sudo: required
before_install:
- pip install mkdocs
- pip install mkdocs-material
- pip install mkdocs-macros-plugin
- pip install pymdown-extensions
- pip install pygments
- npm install -g asyncapi-docgen

install:
- mv CHANGELOG.md docs/changelog.md
- mkdocs build --clean
- cp openapi.json site/
- cp processes.json site/
- cp *.json site/
- rm -f site/apireference/index.html
- rm -f site/processreference/index.html
- rm -f site/apireference-subscriptions/index.html
Expand Down
43 changes: 43 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.3.1]

### Added
- `createProcessGraph` method to client development guidelines.
- JSON file with all specified errors.
- Textual error codes for each specified error.
- Allow setting a plan for `POST /preview`
- Default billing plan in `GET /`.
- Job ID in JSON response for `GET /jobs/{job_id}/results`.

### Changed
- Several optional fields such as `output`, `title` and `description` are now nullable instead of requiring to omit them.
- The output format is not required in `POST /preview` any more and thus allows falling back to the default.
- The `output_format` parameter in `createJob` and `execute` in client development guidelines.
- The `extent` parameters in `filter_bbox` and `filter_daterange` are formally required now.

### Deprecated
- Numeric openEO error codes are soon to be replaced with textual error codes.
- `eo:resolution` in collection bands is a duplicate of `eo:gsd`. Use `eo:gsd` instead.

### Fixed
- Fixed a wrong definition of the header `OpenEO-Costs` in `POST /preview`.
- Fixed typo in method `authenticateOIDC` in client development guidelines.
- Fixed the definition of spatial extents by swapping north and south.
- Replaced the outdated occurrences of `srs` with `crs` in spatial extents.
- Added missing required descriptions to process definitions.
- Added missing error messages.
- Fixed unclear specification for arrays used as process graph arguments.

## [0.3.0] - 2018-09-21
First version after proof of concept tackling many major issues. No changelog available.

## [0.0.2] - 2018-03-22
Version for proof of concept. No changelog available.

## [0.0.1] - 2018-02-07
Initial version.
20 changes: 10 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@

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.

* **[Documentation / Specification](https://open-eo.github.io/openeo-api/v/0.3.0/index.html)**
* **[Documentation / Specification](https://open-eo.github.io/openeo-api/v/0.3.1/index.html)**

## Versions

The openEO (core) API is currently released in version **0.3**.
The openEO (core) API is currently released in version **0.3.1**.

**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](https://github.com/Open-EO/openeo-api/tree/0.0.1) ([Spec](https://open-eo.github.io/openeo-api/v/0.0.1/index.html)) | legacy | First draft with basic ideas, loosely implemented. |
| [0.0.2](https://github.com/Open-EO/openeo-api/tree/0.0.2) ([Spec](https://open-eo.github.io/openeo-api/v/0.0.2/index.html)) | legacy | Proof of concept, implemented. |
| [**0.3.0**](https://github.com/Open-EO/openeo-api/tree/0.3.0) ([Spec](https://open-eo.github.io/openeo-api/v/0.3.0/index.html)) | current | Currently in implementation by clients and back-ends. Major rework. |
| [0.3.1](https://github.com/Open-EO/openeo-api/tree/0.3.1) ([Spec](https://open-eo.github.io/openeo-api/v/0.3.1/index.html)) | planned | Fixing minor issues, see the changelog. |
| [0.4.0](https://github.com/Open-EO/openeo-api/tree/0.4.0) ([Spec](https://open-eo.github.io/openeo-api/v/0.4.0/index.html)) | planned | Planned to add data set and process descriptions and an extension concept. |
| [0.3.0](https://github.com/Open-EO/openeo-api/tree/0.3.0) ([Spec](https://open-eo.github.io/openeo-api/v/0.3.0/index.html)) | legacy | Major rework. |
| [**0.3.1**](https://github.com/Open-EO/openeo-api/tree/0.3.1) ([Spec](https://open-eo.github.io/openeo-api/v/0.3.1/index.html)) | **current** | Fixing minor issues, see the changelog. |
| [0.4.0](https://github.com/Open-EO/openeo-api/tree/0.4.0) ([Spec](https://open-eo.github.io/openeo-api/v/0.4.0/index.html)) | planned | Planned to improve data set descriptions, add process specifications and an extension concept. |

See also the [milestones](https://github.com/Open-EO/openeo-api/milestones) for a rough roadmap based on GitHub issues.
See also the [changelog](CHANGELOG.md) and the [milestones](https://github.com/Open-EO/openeo-api/milestones) for a rough roadmap based on GitHub issues.

## Repository

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

* [openapi.json](openapi.json) ([browseable version](https://open-eo.github.io/openeo-api/v/0.3.0/apireference/)) provides the [openAPI](https://www.openapis.org/) 3.0 definition of the openEO API.
* [processes.json](processes.json) ([browseable version](https://open-eo.github.io/openeo-api/v/0.3.0/processreference/)) defines pre-defined core processes back-ends may implement for best interoperability.
* [subscriptions.json](subscriptions.json) ([browseable version](https://open-eo.github.io/openeo-api/v/0.3.0/apireference-subscriptions/)) provides the [AsyncAPI](https://www.asyncapi.com/) 1.2 definitions for the WebSocket-based subscriptions and notifications API for openEO.
* [docs/](docs/) ([browseable version](https://open-eo.github.io/openeo-api/v/0.3.0/)) contains all additional written documentation, including 'getting started' guides, the architecture, feature descriptions, development guidelines and more.
* [openapi.json](openapi.json) ([browseable version](https://open-eo.github.io/openeo-api/v/0.3.1/apireference/)) provides the [openAPI](https://www.openapis.org/) 3.0 definition of the openEO API.
* [processes.json](processes.json) ([browseable version](https://open-eo.github.io/openeo-api/v/0.3.1/processreference/)) defines pre-defined core processes back-ends may implement for best interoperability.
* [subscriptions.json](subscriptions.json) ([browseable version](https://open-eo.github.io/openeo-api/v/0.3.1/apireference-subscriptions/)) provides the [AsyncAPI](https://www.asyncapi.com/) 1.2 definitions for the WebSocket-based subscriptions and notifications API for openEO.
* [docs/](docs/) ([browseable version](https://open-eo.github.io/openeo-api/v/0.3.1/)) contains all additional written documentation, including 'getting started' guides, the architecture, feature descriptions, development guidelines and more.
2 changes: 0 additions & 2 deletions docs/.gitignore
View file

This file was deleted.

5 changes: 2 additions & 3 deletions docs/arch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,9 @@ To simplify and structure the development, the API is divided into a few microse
| Capabilities | This microservice reports on the capabilities of the back-end, i.e. which API endpoints are implemented, which authentication methods are supported, and whether and how UDFs can be executed at the back-end. |
| EO Data Discovery | Describes which datasets and image collections are available at the back-end. |
| Process Discovery | Provides services to find out which processes a back-end provides, i.e., what users can do with the available data. |
| UDF Runtime Discovery | Allows discovering the programming languages and their runtime environments to execute user-defined functions. |
| UDF | Discovery and execution of user-defined functions. |
| Job Management | Organizes and manages jobs that run processes on back-ends. |
| File Management | Organizes and manages user-uploaded files. |
| Process Graph Management | Organizes and manages user-defined process graphs. |
| Secondary Services Management | External web services to access data and job results such as a OGC WMTS service. |
| User Content | User content and accounting. |
| Authentication | Authentication of users. |
| Account Management | User management, accounting and authentication. |
93 changes: 6 additions & 87 deletions docs/errors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Sending `code` and `message` is REQUIRED.

* A back-end MAY add a free-form `id` (unique identifier) to the error response to be able to log and track errors with further non-disclosable details.

* The `code` is either one of the standardized openEO error codes below or a proprietary error code with a number greater than 10000.
* The `code` is either one of the standardized openEO error codes below or a proprietary error code. Please note, that the numeric error code will be replaced by a descriptive textual code such as `SampleError` in API v0.4.0.

* The `message` explains the reason the server is rejecting the request. For "4xx" error codes the message explains how the client needs to modify the request.

Expand All @@ -52,10 +52,10 @@ The openEO API often uses the following HTTP status codes for failed requests:
The back-end responds with this error code whenever the error has its origin on client side and no other HTTP status code in the 400 range is suitable.

- **401 Unauthorized**:
The client **did not** provide any authorization details (usually using the Authorization header), but authorization is required for this request to be processed.
The client did not provide any authentication details for a resource requiring authentication or the provided authentication details are not correct.

- **403 Forbidden**:
The client **did** provide authorization details (usually using the Authorization header), but the provided credentials or the authorization token is invalid or has expired.
The client did provided correct authentication details, but the privileges/permissions of the provided credentials do not allow to request the resource.

- **404 Not Found**:
The resource specified by the path does not exist, i.e. one of the resources belonging to the specified identifiers are not available at the back-end.
Expand All @@ -74,89 +74,8 @@ All HTTP status codes defined in RFC 7231 in the 400 and 500 ranges can be used

## openEO error codes

The following list of error codes is **incomplete**. These error codes will evolve over time. If you are missing any common error, please contribute it by adding an [issue](https://github.com/Open-EO/openeo-api/issues/new), creating a pull request or get in contact in our [chat room](https://openeo-chat.eodc.eu/channel/public).
The following table of error codes is **incomplete**. These error codes will evolve over time. If you are missing any common error, please contribute it by adding an [issue](https://github.com/Open-EO/openeo-api/issues/new), creating a pull request or get in contact in our [chat room](https://openeo-chat.eodc.eu/channel/public).

### General error codes (xxx)
The whole table of error codes is available as [JSON file](../errors.json), which can be used by implementors to automatically generate error responses.


| openEO Error Code | Description | Message | HTTP Status Code |
| ------- | ---------------------------- | ---------------- | ---------------- |
| 404 | To be used if the value of a path parameter is invalid, i.e. the requested resource is not available. *Note:* Unsupported endpoints MUST use code 501. | Not Found. | 404 |
| 501 | The back-end responds with this error code whenever an endpoint is specified in the openEO API, but is not supported. | Not implemented. | 501 |
| 503 | | Service unavailable. | 503 |
| 601 | | Parameter **X** is invalid. | 400 |
| 611 | Invalid or unsupported CRS specified. | Invalid CRS specified. | 400 |
| 612 | | Coordinate is out of bounds. | 400 |

### Capabilities (11xx)

None yet.

### Data and process discovery (12xx)

None yet.

### UDFs (13xx)

| openEO Error Code | Description | Message | HTTP Status Code |
| ----------------- | ----------- | --------------------------------------- | ---------------- |
| 1301 | | UDF programming language not supported. | 400 / 404 |
| 1302 | | UDF type not supported. | 400 / 404 |

### File Handling (14xx)

| openEO Error Code | Description | Message | HTTP Status Code |
| ----------------- | -------------------------------------------------------- | ------------------------ | ---------------- |
| 1401 | Server couldn't store file due to server-side reasons. | Unable to store file. | 500 |
| 1402 | The storage quota has been exceeded by the user. | Insufficient Storage. | 400 |
| 1410 | File format, file extension or mime type is not allowed. | File type not allowed. | 400 |
| 1411 | File exceeds allowed maximum file size. | File size it too large. | 400 |
| 1412 | The content of the file is invalid. | File content is invalid. | 400 |
| 1413 | The file is locked by a running job or another process. | File is locked. | 400 |


### Process graphs (2xxx)

| openEO Error Code | Description | Message | HTTP Status Code |
| ----------------- | ----------- | ------------------------------------------------------------ | ---------------- |
| 2001 | | No process graph specified. | 400 |
| 2002 | | Process graph structure is invalid. | 400 |
| 2003 | | The array **X** contains values of multiple types. | 400 |
| 2101 | | Process **X** is not supported. | 400 |
| 2102 | | Process argument **X** is not supported. | 400 |
| 2103 | | Invalid value **Y** for the process argument **X** specified. | 400 |
| 2104 | | Required process argument **X** is missing. | 400 |

### Jobs (3xxx)

| openEO Error Code | Description | Message | HTTP Status Code |
| ----------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ---------------- |
| 408 | The (synchronous) request timed out. | Request timed out. | 408 |
| 3001 | | Output format not supported. | 400 |
| 3002 | | Output format argument **X** is not supported. | 400 |
| 3003 | | Invalid value **Y** for the output format argument **X** specified. | 400 |
| 3004 | | Data can't be transformed into the requested output format. | 400 |
| 3005 | The job is currently locked due to an enabled service or a running batch computation and can't be modified meanwhile. | Job is locked. | 400 |
| 3006 | The job has not finished computing the results yet. Try again later. | Results are not finished yet. | 400 |

### Authorization, user content and billing (401-403, 4xxx)

| openEO Error Code | Description | Message | HTTP Status Code |
| ----------------- | ------------------------------------------------------------ | ---------------------------------------- | ---------------- |
| 401 | The back-end responds with this error code whenever the HTTP status code 401 is appropriate (see above) and no other openEO error code in the 4000 range is suitable. | Unauthorized. | 401 |
| 402 | The budget required to fulfil the request are insufficient. | Payment required. | 402 |
| 403 | The back-end responds with this error code whenever the HTTP status code 403 is appropriate (see above) and no other openEO error code in the 4000 range is suitable. | Forbidden. | 403 |
| 4001 | The specified password is not considered secure by the policy of the back-end provider or no password was given at all. The user needs to specify a different password to proceed. | Password does not meet the requirements. | 400 |
| 4031 | Invalid authentication scheme (e.g. Bearer). | | 403 |
| 4032 | Authorization token invalid or expired. | | 403 |
| 4033 | | Credentials are not correct. | 403 |

### Seondary web services (5xxx)

| openEO Error Code | Description | Message | HTTP Status Code |
| ----------------- | ------------------------- | ------------------------------------------------------------ | ---------------- |
| 5001 | | Service type is not supported. | 400 |
| 5101 | Invalid job id specified. | Job does not exist. | 400 |
| 5102 | | Service argument **X** is not supported. | 400 |
| 5103 | | Invalid value **Y** for the service argument **X** specified. | 400 |
| 5104 | | Required service argument **X** is missing. | 400 |
{{ error_codes() }}
Loading

0 comments on commit 616cb18

Please sign in to comment.