Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarified the behaviour of federation:backends for POST /validation #552

Merged
merged 2 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `GET /services/{service_id}` and `GET /jobs/{job_id}`: Explicitly allow listing back-end specific properties (as provided in `POST`)
- Clarified for log levels which default values apply
- 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)
- Clarified the behaviour of `federation:backends` for `POST /validation`

## [1.2.0] - 2021-05-25

Expand Down
16 changes: 14 additions & 2 deletions extensions/federation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,11 @@ Every discoverable resource that is defined as an object and allows to contain a
- `GET /file_formats` (per file format)
- `GET /service_types` (per service)
- `GET /udf_runtimes` (per UDF runtime, per version)
- `POST /validation` (the back-ends that can run the process)
- `POST /validation` (the back-ends that can run the process, see below)
- `GET /process_graphs/{id}`
- `GET /jobs/{job_id}` (the back-ends that generated the result)
- `GET /jobs/{job_id}/results` (the back-ends that generated the result)
- `GET /services/{id}`
- `GET /services/{id}` (the back-ends that host the service)

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

Expand All @@ -189,6 +189,18 @@ schema:

**Note:** In Collections this should generally be provided on the top-level of the object.

### Validation

If this property is returned through the `POST /validation` endpoint, it has the meaning as listed below.
This also covers the case where the federation supports splitting a process into pieces so that different parts can run on different back-ends.

- Endpoint returns *without* errors:
- `federation:backends` is included in the response: The listed back-ends support the workflow (either partially if splitting is supported, or in full).
- `federation:backends` is *not* included in the response: At least one of the back-ends support the workflow.
- Endpoint returns errors:
- `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).
- `federation:backends` is *not* included in the response: None of the back-ends can run the workflow as is.
m-mohr marked this conversation as resolved.
Show resolved Hide resolved

### Examples

#### Process
Expand Down
Loading