Fix the type of children in the /hierarchy S-S API. (#3660)
* Fix the type of children in the /hierarchy S-S API. * Newsfragment
This commit is contained in:
parent
b6b98410c1
commit
fff5f87c3d
2 changed files with 18 additions and 15 deletions
1
changelogs/server_server/newsfragments/3660.new
Normal file
1
changelogs/server_server/newsfragments/3660.new
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Add the Space Hierarchy API (`GET /_matrix/federation/v1/hierarchy/{roomId}`) as per [MSC2946](https://github.com/matrix-org/matrix-doc/pull/2946).
|
|
@ -160,25 +160,27 @@ paths:
|
||||||
required: [origin_server_ts]
|
required: [origin_server_ts]
|
||||||
required: [room_type, allowed_room_ids, children_state]
|
required: [room_type, allowed_room_ids, children_state]
|
||||||
children:
|
children:
|
||||||
|
type: array
|
||||||
description: |-
|
description: |-
|
||||||
A summary of the space's children. Rooms which the requesting server cannot peek/join will
|
A summary of the space's children. Rooms which the requesting server cannot peek/join will
|
||||||
be excluded.
|
be excluded.
|
||||||
allOf:
|
items:
|
||||||
- $ref: "../client-server/definitions/public_rooms_chunk.yaml"
|
allOf:
|
||||||
- type: object
|
- $ref: "../client-server/definitions/public_rooms_chunk.yaml"
|
||||||
properties:
|
- type: object
|
||||||
room_type:
|
properties:
|
||||||
type: string
|
room_type:
|
||||||
description: |-
|
|
||||||
The `type` of room (from [`m.room.create`](/client-server-api/#mroomcreate)), if any.
|
|
||||||
allowed_room_ids:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
If the room is a [restricted room](#restricted-rooms), these are the room IDs which
|
The `type` of room (from [`m.room.create`](/client-server-api/#mroomcreate)), if any.
|
||||||
are specified by the join rules. Empty or omitted otherwise.
|
allowed_room_ids:
|
||||||
required: [room_type, allowed_room_ids, children_state]
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
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:
|
inaccessible_children:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue