Clarify that extra fields of space hierarchy children are not required (

#1741) * 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 <zecakeh@tedomum.fr>
matrix-org · Mar 7, 2024 · a1210ff · a1210ff
1 parent 542a219
commit a1210ff
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 4 deletions.
diff --git a/changelogs/server_server/newsfragments/1741.clarification 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.
diff --git 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:
Original file line number	Diff line number	Diff line change
		@@ -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.