From a1210ff6d119e419160ae68c5f0dfca274ed653b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= <76261501+zecakeh@users.noreply.github.com> Date: Thu, 7 Mar 2024 01:47:28 +0100 Subject: [PATCH] Clarify that extra fields of space hierarchy children are not required (#1741) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Clarify that extra fields of space hierarchy children are not required There is no `children_state` field, the `room_type` is only set for spaces and the description of `allowed_room_ids` says that the field can be omitted. Signed-off-by: Kévin Commaille --- changelogs/server_server/newsfragments/1741.clarification | 1 + data/api/server-server/space_hierarchy.yaml | 4 ---- 2 files changed, 1 insertion(+), 4 deletions(-) create mode 100644 changelogs/server_server/newsfragments/1741.clarification diff --git a/changelogs/server_server/newsfragments/1741.clarification b/changelogs/server_server/newsfragments/1741.clarification new file mode 100644 index 00000000..ec31cac1 --- /dev/null +++ b/changelogs/server_server/newsfragments/1741.clarification @@ -0,0 +1 @@ +Clarify that the `children_state`, `room_type` and `allowed_room_ids` properties in the items of the `children` array of the response of the `GET /hierarchy` endpoint are not required. \ No newline at end of file diff --git a/data/api/server-server/space_hierarchy.yaml b/data/api/server-server/space_hierarchy.yaml index aa98158f..5592f644 100644 --- a/data/api/server-server/space_hierarchy.yaml +++ b/data/api/server-server/space_hierarchy.yaml @@ -119,10 +119,6 @@ paths: description: |- If the room is a [restricted room](#restricted-rooms), these are the room IDs which are specified by the join rules. Empty or omitted otherwise. - required: - - room_type - - allowed_room_ids - - children_state inaccessible_children: type: array items: