Skip to content

Commit 6e431e9

Browse files
authored
PR #564 finetuning of back-end "availability" terminology (#565)
1 parent 6aaf3a6 commit 6e431e9

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

extensions/federation/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,10 @@ schema:
108108

109109
## Resources supported only by a subset of back-ends
110110

111-
Every discoverable resource that is defined as an object and allows to contain additional properties, can list the subset of back-ends that permanently support or host the exposed resource/functionality.
112-
Examples of where this could apply to (**not** comprehensive):
111+
Discoverable resources can explicitly list the subset of back-ends that support or host the exposed resource or functionality with the property `federation:backends`.
112+
113+
Schema-wise, this only applies to resources that are defined as an object and allow to contain additional properties.
114+
For example (**not** comprehensive):
113115

114116
- `GET /collections`
115117
- `GET /collections/{id}`
@@ -198,9 +200,9 @@ This also covers the case where the federation supports splitting a process into
198200
## Temporarily or unintentionally unavailable resources
199201

200202
Resources and back-ends can be temporarily or unintentionally unavailable.
201-
It is especially important to communicate to users missing resources when compiling lists of resources across multiple back-ends.
202-
Clients will assume that all lists of resources are the a combination of all back-ends listed under`federation` in `GET /`.
203-
Federated APIs can expose if any of the back-ends is temporarily not available and thus is not part of the response.
203+
It is especially important to communicate to users missing resources when compiling a **list of resources** across multiple back-ends.
204+
Clients will assume that all lists of resources are a combination of all back-ends listed under `federation` in `GET /`.
205+
Federated APIs can expose if any of the back-ends was not available when building the resource listing response with the property `federation:missing`.
204206

205207
Examples of where this could apply to (**not** comprehensive):
206208

@@ -223,7 +225,7 @@ schema:
223225
properties:
224226
'federation:missing':
225227
description: >-
226-
Lists all back-ends that were temporarily not considered in the response (e.g. because they were not accessible).
228+
Lists all back-ends that were unexpectedly unavailable during compilation of the response.
227229
If not given or empty, all back-ends supporting this endpoint were considered for creating the response.
228230
Back-ends that are listed as offline in the capabilities still need to be listed here.
229231
type: array

0 commit comments

Comments
 (0)