diff --git a/changelogs/client_server/newsfragments/2063.clarification b/changelogs/client_server/newsfragments/2063.clarification new file mode 100644 index 000000000..17cc28906 --- /dev/null +++ b/changelogs/client_server/newsfragments/2063.clarification @@ -0,0 +1 @@ +Clarify which rooms are returned from `/hierarchy`. diff --git a/data/api/client-server/space_hierarchy.yaml b/data/api/client-server/space_hierarchy.yaml index 6329495ce..e851e0421 100644 --- a/data/api/client-server/space_hierarchy.yaml +++ b/data/api/client-server/space_hierarchy.yaml @@ -88,7 +88,16 @@ paths: properties: rooms: type: array - description: The rooms for the current page, with the current filters. + description: |- + The rooms for the current page, with the current filters. + + Rooms which the requesting user can request the [stripped state](#) of are returned, this includes: + + * Any rooms where the requesting user's [room membership](#room-membership) is `join` or `invite` + * Any rooms the user can join: + * Rooms with [join rules](#mroomjoin_rules) set to `join`, `knock`, or `knock_restricted` + * Rooms with a join rule of [`restricted`](#restricted-rooms) if the user meets one of the specified conditions + * Any rooms with [`m.room.history_visibility`](#room-history-visibility) set to `world_readable`. items: allOf: - $ref: definitions/public_rooms_chunk.yaml