Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify which rooms are returned from /hierarchy #2064

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify which rooms are returned from `/hierarchy`.
11 changes: 10 additions & 1 deletion data/api/client-server/space_hierarchy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading