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
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,9 +105,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
105
105
- Additional dimensions in `cube:dimensions` can only be of type `other`.
106
106
- The extents `interval` and `bbox` can have multiple entries.
107
107
- Allow all STAC versions that are compatible to STAC 0.9.0.
108
-
- 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)
108
+
- Process graph nodes have an additional field `namespace` to distinguish predefined and user-defined processes. The default behavior has not changed. [#305](https://github.com/Open-EO/openeo-api/issues/305)
109
109
- Added `format: commonmark` to all properties supporting CommonMark formatting.
110
-
-`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)
110
+
-`errors.json`: The predefined 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)
111
111
- Added `FolderOperationUnsupported`, `UnsupportedApiVersion`, `PermissionsInsufficient`, `ProcessGraphIdDoesntMatch` and `PredefinedProcessExists`.
112
112
- Added variable `reason` to error `FilePathInvalid` and `type` to `FileTypeInvalid` and`ServiceUnsupported`.
113
113
- Replaced the following error messages. The variables in the messages may have changed, too.
Copy file name to clipboardExpand all lines: errors.json
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -225,8 +225,8 @@
225
225
]
226
226
},
227
227
"PredefinedProcessExists": {
228
-
"description": "If a user wants to store a user-defined process with the id of a pre-defined process.",
229
-
"message": "A pre-defined process with the given identifier exists.",
228
+
"description": "If a user wants to store a user-defined process with the id of a predefined process.",
229
+
"message": "A predefined process with the given identifier exists.",
230
230
"http": 400,
231
231
"tags": [
232
232
"User-Defined Processes"
@@ -241,7 +241,7 @@
241
241
]
242
242
},
243
243
"ProcessUnsupported": {
244
-
"description": "A process (pre-defined or user-defined) with the specified identifier is not available. To be used when validating or executing process graphs.",
244
+
"description": "A process (predefined or user-defined) with the specified identifier is not available. To be used when validating or executing process graphs.",
245
245
"message": "Process with identifier '{process}' is not available in namespace '{namespace}'.",
Copy file name to clipboardExpand all lines: openapi.yaml
+20-20Lines changed: 20 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -216,20 +216,20 @@ info:
216
216
217
217
A **process** is an operation that performs a specific task on a set of parameters and returns a result. An example is computing a statistical operation, such as mean or median, on selected EO data. A process is similar to a function or method in programming languages. In openEO, processes are used to build a chain of processes ([process graph](#section/Processes/Process-Graphs)), which can be applied to EO data to derive your own findings from the data.
218
218
219
-
A **pre-defined process** is a process provided by the *back-end*. There is a set of predefined processes by openEO to improve interoperability between back-ends.
220
-
Back-ends SHOULD follow these specifications whenever possible. Not all processes need to be implemented by all back-ends. See the **[process reference](https://processes.openeo.org)** for pre-defined processes.
219
+
A **predefined process** is a process provided by the *back-end*. There is a set of predefined processes by openEO to improve interoperability between back-ends.
220
+
Back-ends SHOULD follow these specifications whenever possible. Not all processes need to be implemented by all back-ends. See the **[process reference](https://processes.openeo.org)** for predefined processes.
221
221
222
222
A **user-defined process** is a process defined by the *user*. It can directly be part of another process graph or be stored as custom process on a back-end. Internally it is a *process graph* with optional additional metadata.
223
223
224
-
A **process graph** chains specific process calls from the set of pre-defined and user-defined processes together. A process graph itself can be stored as a (user-defined) process again. Similarly to scripts in the context of programming, process graphs organize and automate the execution of one or more processes that could alternatively be executed individually. In a process graph, processes need to be specific, i.e. concrete values or "placeholders" for input parameters need to be specified. These values can be scalars, arrays, objects, references to parameters or previous computations or other process graphs.
224
+
A **process graph** chains specific process calls from the set of predefined and user-defined processes together. A process graph itself can be stored as a (user-defined) process again. Similarly to scripts in the context of programming, process graphs organize and automate the execution of one or more processes that could alternatively be executed individually. In a process graph, processes need to be specific, i.e. concrete values or "placeholders" for input parameters need to be specified. These values can be scalars, arrays, objects, references to parameters or previous computations or other process graphs.
225
225
226
226
## Defining Processes
227
227
228
228
Back-ends and users MAY define new proprietary processes for their domain.
229
229
230
230
**Back-end providers** MUST follow the schema for predefined processes as in [`GET /processes`](#operation/list-processes) to define new processes. This includes:
231
231
232
-
* Choosing a intuitive process id, consisting of only letters (a-z), numbers and underscores. It MUST be unique across the pre-defined processes.
232
+
* Choosing a intuitive process id, consisting of only letters (a-z), numbers and underscores. It MUST be unique across the predefined processes.
233
233
* Defining the parameters and their exact (JSON) schemes.
234
234
* Specifying the return value of a process also with a (JSON) schema.
235
235
* Providing examples or compliance tests.
@@ -241,7 +241,7 @@ info:
241
241
* Defining the algorithm as a process graph.
242
242
* Optionally, specifying the additional metadata for processes.
243
243
244
-
If new process are potentially useful for other back-ends the openEO consortium is happily accepting [pull requests](https://github.com/Open-EO/openeo-processes/pulls) to include them in the list of pre-defined processes.
244
+
If new process are potentially useful for other back-ends the openEO consortium is happily accepting [pull requests](https://github.com/Open-EO/openeo-processes/pulls) to include them in the list of predefined processes.
245
245
246
246
### Schemas
247
247
@@ -302,7 +302,7 @@ info:
302
302
303
303
One of the nodes in a map of processes (the final one) MUST have the `result` flag set to `true`, all the other nodes can omit it as the default value is `false`. Having such a node is important as multiple end nodes are possible, but in most use cases it is important to exactly specify the return value to be used by other processes. Each child process graph must also specify a result node similar to the "main" process graph.
304
304
305
-
`process_id` MUST be a valid process ID in the `namespace` given. Clients SHOULD warn the user if a user-defined process is added with the same identifier as one of the pre-defined process.
305
+
`process_id` MUST be a valid process ID in the `namespace` given. Clients SHOULD warn the user if a user-defined process is added with the same identifier as one of the predefined process.
306
306
307
307
### Arguments
308
308
@@ -349,7 +349,7 @@ info:
349
349
consists of a single process `absolute`, but it can be arbitrary complex in general.
350
350
351
351
A `<UserDefinedProcess>` argument MUST at least consist of an object with a key `process_graph`.
352
-
Optionally, it can also be described with the same additional properties available for pre-defined processes such as an id, parameters, return values etc.
352
+
Optionally, it can also be described with the same additional properties available for predefined processes such as an id, parameters, return values etc.
353
353
When embedded in a process graph, these additional properties of a user-defined process are usually not used, except for validation purposes.
354
354
355
355
```
@@ -1546,7 +1546,7 @@ paths:
1546
1546
type: array
1547
1547
items:
1548
1548
title: Pre-Defined Process
1549
-
description: A pre-defined process made available by the back-end.
1549
+
description: A predefined process made available by the back-end.
1550
1550
type: object
1551
1551
required:
1552
1552
- id
@@ -1853,13 +1853,13 @@ paths:
1853
1853
List of default OpenID Connect clients that can be used by an openEO client
1854
1854
for OpenID Connect based authentication.
1855
1855
1856
-
A default OpenID Connect client is managed by the backend implementer.
1856
+
A default OpenID Connect client is managed by the back-end implementer.
1857
1857
It MUST be configured to be usable without a client secret,
1858
1858
which limits its applicability to OpenID Connect grant types like
1859
1859
"Authorization Code Grant with PKCE" and "Device Authorization Grant with PKCE"
1860
1860
1861
1861
A default OpenID Connect client is provided without availability guarantees.
1862
-
The backend implementer CAN revoke, reset or update it any time.
1862
+
The back-end implementer CAN revoke, reset or update it any time.
1863
1863
As such, openEO clients SHOULD NOT store or cache default OpenID Connect client information
1864
1864
for long term usage.
1865
1865
A default OpenID Connect client is intended to simplify authentication for novice users.
@@ -2281,7 +2281,7 @@ paths:
2281
2281
be changed for stored user-defined processes.
2282
2282
2283
2283
The id MUST be unique for the authenticated user, including all
2284
-
pre-defined processes by the back-end.
2284
+
predefined processes by the back-end.
2285
2285
2286
2286
Partially updating user-defined processes is not supported.
2287
2287
@@ -3563,7 +3563,7 @@ components:
3563
3563
description: |-
3564
3564
The type of the UDF runtime.
3565
3565
3566
-
Pre-defined types are:
3566
+
Predefined types are:
3567
3567
* `language` for Programming Languages and
3568
3568
* `docker` for Docker Containers.
3569
3569
@@ -5071,16 +5071,16 @@ components:
5071
5071
description: |-
5072
5072
The namespace the `process_id` is valid for.
5073
5073
5074
-
The following options are pre-defined by the openEO API, but additional
5074
+
The following options are predefined by the openEO API, but additional
5075
5075
namespaces may be introduced by back-ends or in a future version of the API.
5076
5076
5077
-
* `null` (default): Checks both user-defined and pre-defined processes,
5077
+
* `null` (default): Checks both user-defined and predefined processes,
5078
5078
but prefers user-defined processes if both are available.
5079
-
This allows users to add missing pre-defined processes for portability,
5079
+
This allows users to add missing predefined processes for portability,
5080
5080
e.g. common processes from [processes.openeo.org](https://processes.openeo.org)
5081
5081
that have a process graph included.
5082
5082
It is RECOMMENDED to log the namespace selected by the back-end for debugging purposes.
5083
-
* `backend`: Uses exclusively the pre-defined processes listed at `GET /processes`.
5083
+
* `backend`: Uses exclusively the predefined processes listed at `GET /processes`.
5084
5084
* `user`: Uses exclusively the user-defined processes listed at `GET /process_graphs`.
5085
5085
5086
5086
If multiple processes with the same identifier exist, Clients SHOULD
@@ -5089,10 +5089,10 @@ components:
5089
5089
type: string
5090
5090
description: |-
5091
5091
The identifier for the process. It MUST be unique across its namespace
5092
-
(e.g. pre-defined processes or user-defined processes).
5092
+
(e.g. predefined processes or user-defined processes).
5093
5093
5094
5094
Clients SHOULD warn the user if a user-defined process is added with the
5095
-
same identifier as one of the pre-defined process.
5095
+
same identifier as one of the predefined process.
5096
5096
pattern: '^\w+$'
5097
5097
example: ndvi
5098
5098
process_summary:
@@ -6118,9 +6118,9 @@ components:
6118
6118
pagination MUST return all resources.
6119
6119
6120
6120
If the response is paginated, the `links` array MUST be used to communicate the
6121
-
links for browsing the pagination with pre-defined `rel` types. See the `links` array schema
6121
+
links for browsing the pagination with predefined `rel` types. See the `links` array schema
6122
6122
for supported `rel` types.
6123
-
Backend implementations can, unless specified otherwise, use all kind of pagination techniques,
6123
+
Back-end implementations can, unless specified otherwise, use all kind of pagination techniques,
6124
6124
depending on what is supported best by their infrastructure: page-based, offset-based, token-based
6125
6125
or something else. The clients SHOULD use whatever is specified
0 commit comments