You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: extensions/federation/README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,8 +108,10 @@ schema:
108
108
109
109
## Resources supported only by a subset of back-ends
110
110
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):
113
115
114
116
-`GET /collections`
115
117
-`GET /collections/{id}`
@@ -198,9 +200,9 @@ This also covers the case where the federation supports splitting a process into
198
200
## Temporarily or unintentionally unavailable resources
199
201
200
202
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`.
204
206
205
207
Examples of where this could apply to (**not** comprehensive):
206
208
@@ -223,7 +225,7 @@ schema:
223
225
properties:
224
226
'federation:missing':
225
227
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.
227
229
If not given or empty, all back-ends supporting this endpoint were considered for creating the response.
228
230
Back-ends that are listed as offline in the capabilities still need to be listed here.
0 commit comments