Skip to content

Commit

Permalink
Clarify behaviour in POST /validation
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr authored Dec 13, 2024
1 parent c5a45b4 commit f39ef46
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion extensions/federation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,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.

### Examples

#### Process
Expand Down Expand Up @@ -213,4 +225,5 @@ schema:
},
...
}
```
```

0 comments on commit f39ef46

Please sign in to comment.