Skip to content

Commit e5ac184

Browse files
committed
pre-defined => predefined, backend => back-end
1 parent 9d95822 commit e5ac184

File tree

3 files changed

+25
-25
lines changed

3 files changed

+25
-25
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
105105
- Additional dimensions in `cube:dimensions` can only be of type `other`.
106106
- The extents `interval` and `bbox` can have multiple entries.
107107
- 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)
109109
- 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)
111111
- Added `FolderOperationUnsupported`, `UnsupportedApiVersion`, `PermissionsInsufficient`, `ProcessGraphIdDoesntMatch` and `PredefinedProcessExists`.
112112
- Added variable `reason` to error `FilePathInvalid` and `type` to `FileTypeInvalid` and`ServiceUnsupported`.
113113
- Replaced the following error messages. The variables in the messages may have changed, too.

errors.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,8 @@
225225
]
226226
},
227227
"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.",
230230
"http": 400,
231231
"tags": [
232232
"User-Defined Processes"
@@ -241,7 +241,7 @@
241241
]
242242
},
243243
"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.",
245245
"message": "Process with identifier '{process}' is not available in namespace '{namespace}'.",
246246
"http": 400,
247247
"tags": [

openapi.yaml

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -216,20 +216,20 @@ info:
216216
217217
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.
218218
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.
221221
222222
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.
223223
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.
225225
226226
## Defining Processes
227227
228228
Back-ends and users MAY define new proprietary processes for their domain.
229229
230230
**Back-end providers** MUST follow the schema for predefined processes as in [`GET /processes`](#operation/list-processes) to define new processes. This includes:
231231
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.
233233
* Defining the parameters and their exact (JSON) schemes.
234234
* Specifying the return value of a process also with a (JSON) schema.
235235
* Providing examples or compliance tests.
@@ -241,7 +241,7 @@ info:
241241
* Defining the algorithm as a process graph.
242242
* Optionally, specifying the additional metadata for processes.
243243
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.
245245
246246
### Schemas
247247
@@ -302,7 +302,7 @@ info:
302302
303303
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.
304304
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.
306306
307307
### Arguments
308308
@@ -349,7 +349,7 @@ info:
349349
consists of a single process `absolute`, but it can be arbitrary complex in general.
350350
351351
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.
353353
When embedded in a process graph, these additional properties of a user-defined process are usually not used, except for validation purposes.
354354
355355
```
@@ -1546,7 +1546,7 @@ paths:
15461546
type: array
15471547
items:
15481548
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.
15501550
type: object
15511551
required:
15521552
- id
@@ -1853,13 +1853,13 @@ paths:
18531853
List of default OpenID Connect clients that can be used by an openEO client
18541854
for OpenID Connect based authentication.
18551855
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.
18571857
It MUST be configured to be usable without a client secret,
18581858
which limits its applicability to OpenID Connect grant types like
18591859
"Authorization Code Grant with PKCE" and "Device Authorization Grant with PKCE"
18601860
18611861
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.
18631863
As such, openEO clients SHOULD NOT store or cache default OpenID Connect client information
18641864
for long term usage.
18651865
A default OpenID Connect client is intended to simplify authentication for novice users.
@@ -2281,7 +2281,7 @@ paths:
22812281
be changed for stored user-defined processes.
22822282
22832283
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.
22852285
22862286
Partially updating user-defined processes is not supported.
22872287
@@ -3563,7 +3563,7 @@ components:
35633563
description: |-
35643564
The type of the UDF runtime.
35653565
3566-
Pre-defined types are:
3566+
Predefined types are:
35673567
* `language` for Programming Languages and
35683568
* `docker` for Docker Containers.
35693569
@@ -5071,16 +5071,16 @@ components:
50715071
description: |-
50725072
The namespace the `process_id` is valid for.
50735073
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
50755075
namespaces may be introduced by back-ends or in a future version of the API.
50765076
5077-
* `null` (default): Checks both user-defined and pre-defined processes,
5077+
* `null` (default): Checks both user-defined and predefined processes,
50785078
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,
50805080
e.g. common processes from [processes.openeo.org](https://processes.openeo.org)
50815081
that have a process graph included.
50825082
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`.
50845084
* `user`: Uses exclusively the user-defined processes listed at `GET /process_graphs`.
50855085
50865086
If multiple processes with the same identifier exist, Clients SHOULD
@@ -5089,10 +5089,10 @@ components:
50895089
type: string
50905090
description: |-
50915091
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).
50935093
50945094
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.
50965096
pattern: '^\w+$'
50975097
example: ndvi
50985098
process_summary:
@@ -6118,9 +6118,9 @@ components:
61186118
pagination MUST return all resources.
61196119
61206120
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
61226122
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,
61246124
depending on what is supported best by their infrastructure: page-based, offset-based, token-based
61256125
or something else. The clients SHOULD use whatever is specified
61266126
in the links with the corresponding `rel` types.

0 commit comments

Comments
 (0)