Merge pull request #265 from Open-EO/draft

Release 1.0.0 RC2

Author: m-mohr

CHANGELOG.md

@@ -4,6 +4,36 @@ 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).
 
+## Unreleased / Draft
+
+## 1.0.0-rc.2 - 2020-02-20
+
+### Added
+- `PUT /process_graphs/{process_graph_id}` to store and replace custom process-graphs. [#260](https://github.com/Open-EO/openeo-api/issues/260)
+- `/jobs/{job_id}/logs` and `GET /services/{service_id}/logs`: Reintroduced the missing `offset` parameter.
+
+### Changed
+- For batch jobs (`/jobs`), services (`/services`) and sync. processing (`/result`) the property `process_graph` got replaced by `process`. It contains a process graph and optionally all process metadata. [#260](https://github.com/Open-EO/openeo-api/issues/260)
+- `GET /process_graphs`: Field `id` is required for each process.
+- Several properties in user-defined processes can now be `null` (see also [#264](https://github.com/Open-EO/openeo-api/issues/264)):
+    - `GET /process_graphs` and `GET /process_graphs/{process_graph_id}`: Process properties `summary`, `description`, `parameters` and `returns`.
+    - `POST /validation`: Process property `id`.
+    - Child processes in process graphs (fka callbacks): `id`, `summary`, `description`, `parameters` and `returns`.
+
+### Removed
+- `POST /process_graphs` and `PATCH /process_graphs/{process_graph_id}`. Use `PUT /process_graphs/{process_graph_id}` instead. [#260](https://github.com/Open-EO/openeo-api/issues/260)
+
+### Fixed
+- Added `$id` to JSON Schema file for subtypes.
+- Fixed invalid EPSG code example.
+- Fixed collection example (`sat:cloud_cover` changed to `eo:cloud_cover`).
+- Fixed invalid JSON Schema for process graph validation (used `from_argument` instead of `from_parameter`).
+- Clarified how version numbers in well-known discovery are compared. [#259](https://github.com/Open-EO/openeo-api/issues/259)
+- Clarified that back-ends not supporting pagination will return all resources.
+- Clarified how `from_parameter` is resolved in case no value is given.
+- Clarified `GET .../logs` endpoint behaviour.
+- Removed outdated error codes from `errors.json`.
+
 ## 1.0.0-rc.1 - 2020-01-31
 
 **Note:** The user and developer documentation has been moved to [openeo.org](https://openeo.org/documentation).
@@ -39,18 +69,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - `from_parameter` can access parameters defined in parent scopes.
     - `from_parameter` can be used in the top-level process graph.
     - Process graph variables (objects with `variable_id` etc.) have been removed.
-- `GET /jobs`, `GET /jobs/{job_id}`, `GET /services` and `GET /services/{service_id}`: Renamed field `submitted` to `created` for consistency with STAC job results.
+- `GET /jobs`, `GET /jobs/{job_id}`, `GET /services` and `GET /services/{service_id}`: Renamed field `submitted` to `created` for consistency with STAC job results. Also renamed the corresponding value in the field `status` for batch jobs.
 - `GET /`: Property `links` is required.
-- `GET /service_types`:
-    - `parameter` has been renamed to `configuration` to not overlap with `process_parameters`.
-    - `variables` has been renamed to `process_parameters` and has a different schema now. [#161](https://github.com/Open-EO/openeo-api/issues/161)
+- `GET /service_types`: `variables` has been renamed to `process_parameters` and has a different schema now. [#161](https://github.com/Open-EO/openeo-api/issues/161)
+- `GET /service_types`, `POST /services`, `GET /services/{service_id}`, `PATCH /services/{service_id}`: `parameter` has been renamed to `configuration` to not overlap with `process_parameters`.
 - `GET /processes`:
     - Default values are now specified on the parameter-level, not in the JSON schemas.
     - Multiple data types in parameters or return values are supported as arrays. Using `anyOf` is discouraged.
     - Parameters are defined as array. `parameter_order` is therefore removed and the name is part of the parameter object. [#239](https://github.com/Open-EO/openeo-api/issues/239)
     - Process graph (callback) parameters have a new, more advanced schema, allowing to define more aspects of the process graph parameters. [#239](https://github.com/Open-EO/openeo-api/issues/239)
     - Return values don't require a description any longer.
     - `required` was replaced with `optional` with inverted behavior.
+- `POST /process_graphs`,`GET /process_graphs/{process_graph_id}`, `PATCH /process_graphs/{process_graph_id}`, `POST /validation`: Request and response bodies have been completely reworked to follow the same schema as `GET /processes`. Each process graph is now basically a process a user can use in other process graphs.
 - `GET /collections` and `GET /collections/{collectionId}`: Updated STAC to version 0.9.0. See the [STAC Changelog](https://github.com/radiantearth/stac-spec/blob/master/CHANGELOG.md) for more details. [#247](https://github.com/Open-EO/openeo-api/issues/247), [#204](https://github.com/Open-EO/openeo-api/issues/204).
 - `GET /credentials/oidc`: Changed response to support multiple OpenID Connect identity providers ([#201](https://github.com/Open-EO/openeo-api/issues/201)) and clarified workflow overall.
 - Bearer token are built from the authentication method, an optional provider id and the token itself. [#219](https://github.com/Open-EO/openeo-api/issues/219)

README.md

@@ -2,16 +2,17 @@
 
 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://api.openeo.org)**
+* **[Latest Version of the Specification](https://api.openeo.org)**
 
-## Versions
+## Versions / Branches
 
-The openEO (core) API is currently released in version **1.0.0-rc.1**.
+The [master branch](https://github.com/Open-EO/openeo-api/tree/master) is the 'stable' version of the openEO API specification. It is currently version **1.0.0-rc.2** of the specification. The [draft branch](https://github.com/Open-EO/openeo-api/tree/draft) is where active development takes place.
 
 | Version / Branch                                          | Status      | Description |
 | --------------------------------------------------------- | ----------- | ----------- |
-| [draft](https://api.openeo.org/draft)                     | planned     | Bug fixes based on developer feedback, introduce extension concept. Potentially version 1.0.0-final. |
-| [**1.0.0-rc.1**](https://api.openeo.org)                  | **current** | Release candidate for first stable version of openEO, see the [changelog](CHANGELOG.md#100-rc1---2020-01-31). |
+| [draft](https://api.openeo.org/draft)                     | planned     | *Unstable* - Bug fixes based on developer feedback, introduce extension concept. Potentially version 1.0.0-final. |
+| [**1.0.0-rc.2**](https://api.openeo.org)                  | **current** | Release candidate 2 for first stable version of openEO, see the [changelog](CHANGELOG.md#100-rc2---2020-02-20). |
+| [1.0.0-rc.1](https://api.openeo.org/1.0.0-rc.1)           | legacy      | Release candidate 1 for first stable version of openEO, see the [changelog](CHANGELOG.md#100-rc1---2020-01-31). |
 | [0.4.2](https://api.openeo.org/v/0.4.2)                   | legacy      | Bugfix release, see the [changelog](CHANGELOG.md#042---2019-06-11). |
 | [0.4.1](https://api.openeo.org/v/0.4.1)                   | legacy      | Bugfix release, see the [changelog](CHANGELOG.md#041---2019-05-29). |
 | [0.4.0](https://api.openeo.org/v/0.4.0)                   | legacy      | Improved discovery, added processes catalogue, new process graph structure and [more](CHANGELOG.md#040---2019-03-07). |
@@ -26,7 +27,7 @@ See also the [changelog](CHANGELOG.md) and the [milestones](https://github.com/O
 
 This repository contains a set of files formally describing the openEO API, each with a human-readable and easily browseable version:
 
-* [openapi.yaml](openapi.yaml) ([human-readable version](https://api.openeo.org/)) provides the [openAPI](https://www.openapis.org/) 3.0 definition of the openEO API.
+* [openapi.yaml](openapi.yaml) provides the [OpenAPI](https://www.openapis.org/) 3.0 definition of the openEO API. See the table above for human-readable versions of the OpenAPI definition.
 * [errors.json](errors.json) is a list of potential global error codes and messages, excluding specific exceptions separately available for each process.
 * [subtype-schema.json](subtype-schema.json) defines data types (subtypes) for JSON Schema used in openEO.
 * The [assets](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.

assets/pg-schema.json

@@ -58,7 +58,7 @@
           "type": "object",
           "title": "Object",
           "properties": {
-            "from_argument": {
+            "from_parameter": {
               "not": {}
             },
             "from_node": {
@@ -131,7 +131,7 @@
     "process_id": {
       "type": "string",
       "subtype": "process-id",
-      "pattern": "^[A-Za-z0-9_]+$"
+      "pattern": "^\\w+$"
     }
   }
 }

errors.json

@@ -245,9 +245,9 @@
 			"Processes"
 		]
 	},
-	"ProcessArgumentsMissing": {
+	"ProcessParameterMissing": {
 		"description": null,
-		"message": "Process '{process}' requires at least {min_parameters} parameters.",
+		"message": "The process parameter '{parameter}' must be specified.",
 		"http": 400,
 		"tags": [
 			"Processes"