mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-13 15:04:10 +01:00
Clarify which rooms are returned from /hierarchy
Signed-off-by: Patrick Cloke <clokep@patrick.cloke.us>
This commit is contained in:
parent
ad17652fce
commit
d519075bc8
|
|
@ -0,0 +1 @@
|
||||||
|
Clarify which rooms are returned from `/hierarchy`.
|
||||||
|
|
@ -88,7 +88,16 @@ paths:
|
||||||
properties:
|
properties:
|
||||||
rooms:
|
rooms:
|
||||||
type: array
|
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:
|
items:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: definitions/public_rooms_chunk.yaml
|
- $ref: definitions/public_rooms_chunk.yaml
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue