You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+64-1
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,72 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6
6
7
7
## Unreleased / Draft
8
8
9
+
10
+
## 1.0.0 - 2020-07-17
11
+
12
+
### Added
13
+
-`GET /me`: Added optional `name` property to better separate an internal user id from a displayable user name. Adopted description of `user_id` accordingly.
14
+
-`GET /udf_runtimes`:
15
+
- Added optional `title` property for UDF runtimes. [#266](https://github.com/Open-EO/openeo-api/issues/266)
16
+
- Added required `type` property for UDF runtimes to support better code generation.
17
+
-`GET /service_types`: Added optional `title` and `description` properties for service types. [#266](https://github.com/Open-EO/openeo-api/issues/266)
18
+
-`GET /file_formats`: Added optional `description` property for file formats. [#266](https://github.com/Open-EO/openeo-api/issues/266)
19
+
-`GET /collections/{collection_id}` and `GET /processes`: Mention of link `rel` type `example` to refer to examples. [#285](https://github.com/Open-EO/openeo-api/issues/285)
20
+
-`GET /collections/{collection_id}`: Added optional `assets` property for collection-level assets. This may link to visualizations for example. [#211](https://github.com/Open-EO/openeo-api/issues/211)
21
+
-`GET /collections`, `GET /jobs`, `GET /process_graphs`, `GET /Services`: Allow all non-scalar properties to be part of the response although strongly discouraged.
22
+
23
+
### Changed
24
+
-`GET /credentials/oidc`: field `scopes` is not required anymore, but when specified, it should contain the `openid` scope. [#288](https://github.com/Open-EO/openeo-api/pull/288)
25
+
-`GET /.well-known/openeo` and `GET /`: `production` fields default to `false` instead of `true`.
26
+
-`GET /jobs/{job_id}/logs` and `GET /services/{service_id}/logs`: `path` property is not required any longer. [#320](https://github.com/Open-EO/openeo-api/issues/320)
27
+
-`GET /file_formats`: `parameters` is now required for each file format. [#318](https://github.com/Open-EO/openeo-api/issues/318)
28
+
-`GET /service_types`: `configuration` and `process_parameters` are now required for each service. [#318](https://github.com/Open-EO/openeo-api/issues/318)
29
+
-`GET /service_types` and `GET /file_formats`:
30
+
- Allow full JSON Schema for parameters, instead of a very limited subset.
31
+
- Instead of the proprietary property `example` use `examples` from JSON Schema instead.
32
+
-`GET /collections` and `GET /collections/{collection_id}`:
33
+
- Additional dimensions in `cube:properties` can only be of type `other`.
34
+
- The extents `interval` and `bbox` can have multiple entries.
35
+
- Allow all STAC versions that are compatible to STAC 0.9.0.
36
+
- Process graph nodes have an additional field `namespace` to distinguish pre-defined and user-defined processes. The default behavior has not changed. [#305](https://github.com/Open-EO/openeo-api/issues/305)
37
+
- Added `format: commonmark` to all properties supporting CommonMark formatting.
38
+
-`errors.json`: The pre-defined error messages have been reworked. [#272](https://github.com/Open-EO/openeo-api/issues/272), [#273](https://github.com/Open-EO/openeo-api/issues/273)
39
+
- Added `FolderOperationUnsupported`, `UnsupportedApiVersion`, `PermissionsInsufficient`, `ProcessGraphIdDoesntMatch` and `PredefinedProcessExists`.
40
+
- Added variable `reason` to error `FilePathInvalid` and `type` to `FileTypeInvalid` and`ServiceUnsupported`.
41
+
- Replaced the following error messages. The variables in the messages may have changed, too.
- 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`.
49
+
50
+
### Removed
51
+
-`GET /processes`: Examples containing process graphs. Use links with `rel` type `example` and `type` set to `application/json` instead. [#285](https://github.com/Open-EO/openeo-api/issues/285)
52
+
-`subtype-schemas.json`. It's now published as part of [openeo-processes](https://github.com/Open-EO/openeo-processes/blob/master/meta/subtype-schemas.json).
53
+
54
+
### Fixed
55
+
-`/.well-known/openeo`:
56
+
- Clarified that version numbers must be unique. [#287](https://github.com/Open-EO/openeo-api/issues/287)
57
+
- Clarified that non-production ready versions should be connected to if no production-ready version is supported. [#289](https://github.com/Open-EO/openeo-api/issues/289)
58
+
-`GET /jobs/{job_id}/results`: Clarified that unlocated results set `geometry` to `null` and omit the `bbox` property.
59
+
-`GET /jobs/{job_id}/logs`: Clarified that back-ends can log at any stage of the job. [#315](https://github.com/Open-EO/openeo-api/issues/315)
60
+
-`POST /jobs` and `POST /services`: Clarified definition of `Location` header in `HTTP 201` responses. [#269](https://github.com/Open-EO/openeo-api/issues/269)
61
+
-`GET /service/{service_id}`: Property `configuration` is required instead of a non-existing property named `parameters`.
62
+
-`POST /validation`: Clarify that unresolvable process parameters must not throw. [#314](https://github.com/Open-EO/openeo-api/issues/314)
63
+
- Formally forbid 5 elements in bounding boxes.
64
+
- Re-use corresponding schema for header `OpenEO-Identifier` (adds `pattern`).
65
+
- Parameters passed to child process graphs are not defined recursively any longer. [#268](https://github.com/Open-EO/openeo-api/issues/268)
66
+
- Parameters for child process graphs are not specified for return values and service type parameters any longer. [#268](https://github.com/Open-EO/openeo-api/issues/268)
67
+
- Clarified the expected behavior for process parameters, if a default value is given and the parameter is implicitly set to be required. [#303](https://github.com/Open-EO/openeo-api/issues/303)
68
+
- Several clarifications and improvements for the documentation.
69
+
9
70
## 1.0.0-rc.2 - 2020-02-20
10
71
11
72
### Added
12
73
-`PUT /process_graphs/{process_graph_id}` to store and replace custom process-graphs. [#260](https://github.com/Open-EO/openeo-api/issues/260)
13
-
-`/jobs/{job_id}/logs` and `GET /services/{service_id}/logs`: Reintroduced the missing `offset` parameter.
74
+
-`GET .../logs`: Reintroduced the missing `offset` parameter.
14
75
15
76
### Changed
16
77
- 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)
@@ -32,6 +93,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
32
93
- Clarified that back-ends not supporting pagination will return all resources.
33
94
- Clarified how `from_parameter` is resolved in case no value is given.
34
95
- Clarified `GET .../logs` endpoint behaviour.
96
+
- Clarify difference between STAC specification and STAC API.
97
+
- Clarify that a copy of the STAC Item is recommended to be part of the assets in a batch job download.
35
98
- Removed outdated error codes from `errors.json`.
Copy file name to clipboardExpand all lines: README.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -6,17 +6,18 @@ openEO develops an open API to connect R, Python and JavaScript clients to big E
6
6
7
7
## Versions / Branches
8
8
9
-
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.
9
+
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** of the specification. The [draft branch](https://github.com/Open-EO/openeo-api/tree/draft) is where active development takes place.
|[draft](https://api.openeo.org/draft)| planned |*Unstable* - Bug fixes based on developer feedback, introduce extension concept. Potentially version 1.0.0-final. |
14
-
|[**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). |
15
-
|[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). |
16
-
|[0.4.2](https://api.openeo.org/v/0.4.2)| legacy | Bugfix release, see the [changelog](CHANGELOG.md#042---2019-06-11). |
17
-
|[0.4.1](https://api.openeo.org/v/0.4.1)| legacy | Bugfix release, see the [changelog](CHANGELOG.md#041---2019-05-29). |
18
-
|[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). |
19
-
|[0.3.1](https://api.openeo.org/v/0.3.1)| legacy | Fixing minor issues, see the [changelog](CHANGELOG.md#031---2018-11-06). |
13
+
|[draft](https://api.openeo.org/draft)| planned |*Unstable* - Next version. |
14
+
|[**1.0.0**](https://api.openeo.org)|**current**| First stable version of openEO. [Changelog](CHANGELOG.md#100---2020-07-17). |
|[1.0.0-rc.1](https://api.openeo.org/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](CHANGELOG.md#100-rc1---2020-01-31)|
|[0.3.0](https://api.openeo.org/v/0.3.0)| legacy | Major rework. |
21
22
|[0.0.2](https://github.com/Open-EO/openeo-api/tree/0.0.2)| legacy | Proof of concept, implemented. |
22
23
|[0.0.1](https://github.com/Open-EO/openeo-api/tree/0.0.1)| legacy | First draft with basic ideas, loosely implemented. |
@@ -29,5 +30,4 @@ This repository contains a set of files formally describing the openEO API, each
29
30
30
31
*[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.
31
32
*[errors.json](errors.json) is a list of potential global error codes and messages, excluding specific exceptions separately available for each process.
32
-
*[subtype-schema.json](subtype-schema.json) defines data types (subtypes) for JSON Schema used in openEO.
33
33
* 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.
0 commit comments