Skip to content

Commit 0f81fd8

Browse files
m-mohrsoxofaan
andauthored
Clarified the behaviour of federation:backends for POST /validation (Open-EO#552)
* Clarified the behaviour of `federation:backends` for `POST /validation` * Update extensions/federation/README.md Co-authored-by: Stefaan Lippens <soxofaan@users.noreply.github.com> --------- Co-authored-by: Stefaan Lippens <soxofaan@users.noreply.github.com>
1 parent 7833f93 commit 0f81fd8

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1919
- `GET /services/{service_id}` and `GET /jobs/{job_id}`: Explicitly allow listing back-end specific properties (as provided in `POST`)
2020
- Clarified for log levels which default values apply
2121
- Clarified how the relation types `license`, `version-history` and `author` can be used to enrich the process metadata. [#531](https://github.com/Open-EO/openeo-api/issues/531)
22+
- Clarified the behaviour of `federation:backends` for `POST /validation`
2223

2324
## [1.2.0] - 2021-05-25
2425

extensions/federation/README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -164,11 +164,11 @@ Every discoverable resource that is defined as an object and allows to contain a
164164
- `GET /file_formats` (per file format)
165165
- `GET /service_types` (per service)
166166
- `GET /udf_runtimes` (per UDF runtime, per version)
167-
- `POST /validation` (the back-ends that can run the process)
167+
- `POST /validation` (the back-ends that can run the process, see below)
168168
- `GET /process_graphs/{id}`
169169
- `GET /jobs/{job_id}` (the back-ends that generated the result)
170170
- `GET /jobs/{job_id}/results` (the back-ends that generated the result)
171-
- `GET /services/{id}`
171+
- `GET /services/{id}` (the back-ends that host the service)
172172

173173
This can also be embedded deeply into a hierarchical structure, e.g. for process or file format parameters.
174174

@@ -189,6 +189,18 @@ schema:
189189
190190
**Note:** In Collections this should generally be provided on the top-level of the object.
191191
192+
### Validation
193+
194+
If this property is returned through the `POST /validation` endpoint, it has the meaning as listed below.
195+
This also covers the case where the federation supports splitting a process into pieces so that different parts can run on different back-ends.
196+
197+
- Endpoint returns *without* errors:
198+
- `federation:backends` is included in the response: The listed back-ends support the workflow (either partially if splitting is supported, or in full).
199+
- `federation:backends` is *not* included in the response: At least one of the back-ends support the workflow.
200+
- Endpoint returns errors:
201+
- `federation:backends` is included in the response: The listed back-ends were checked and none of the back-ends can run the workflow as is (neither splitted if supported, nor in full).
202+
- `federation:backends` is *not* included in the response: the workflow could not be validated successfully by any of the back-ends or the federation component itself.
203+
192204
### Examples
193205

194206
#### Process

0 commit comments

Comments
 (0)