wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Clarify which rooms are returned from /hierarchy (#2064)

Browse source 
Signed-off-by: Patrick Cloke <clokep@patrick.cloke.us>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
This commit is contained in:
Patrick Cloke 2025-02-14 07:06:21 -05:00 • committed by GitHub
parent c2ef38f0e5
commit cb83c5a76e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/2064.clarification Normal file
View file

@ -0,0 +1 @@
Clarify which rooms are returned from `/hierarchy`.

13
data/api/client-server/space_hierarchy.yaml
View file

@ -88,7 +88,18 @@ 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.
The server should return any rooms where at least one of the following conditions is true:
* The requesting user is currently a member (their [room membership](#room-membership) is `join`).
* The requesting user already has permission to join, i.e. one of the following:
* The user's room membership is `invite`.
* The room's [join rules](#mroomjoin_rules) are set to `public`.
* The room's join rules are set to [`restricted`](#restricted-rooms), provided the user meets one of the specified conditions.
* The room is "knockable" (the room's join rules are set to `knock`, or `knock_restricted`, in a room version that supports those settings).
* The room's [`m.room.history_visibility`](#room-history-visibility) is set to `world_readable`.
items:
allOf:
- $ref: definitions/public_rooms_chunk.yaml