Skip to content

Commit

Permalink
Fix the type of children in the /hierarchy S-S API. (#3660)
Browse files Browse the repository at this point in the history
* Fix the type of children in the /hierarchy S-S API.

* Newsfragment
  • Loading branch information
clokep authored Jan 19, 2022
1 parent b6b9841 commit fff5f87
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 15 deletions.
1 change: 1 addition & 0 deletions changelogs/server_server/newsfragments/3660.new
Original file line number Diff line number Diff line change
@@ -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).
32 changes: 17 additions & 15 deletions data/api/server-server/space_hierarchy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -160,25 +160,27 @@ paths:
required: [origin_server_ts]
required: [room_type, allowed_room_ids, children_state]
children:
type: array
description: |-
A summary of the space's children. Rooms which the requesting server cannot peek/join will
be excluded.
allOf:
- $ref: "../client-server/definitions/public_rooms_chunk.yaml"
- type: object
properties:
room_type:
type: string
description: |-
The `type` of room (from [`m.room.create`](/client-server-api/#mroomcreate)), if any.
allowed_room_ids:
type: array
items:
items:
allOf:
- $ref: "../client-server/definitions/public_rooms_chunk.yaml"
- type: object
properties:
room_type:
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]
description: |-
The `type` of room (from [`m.room.create`](/client-server-api/#mroomcreate)), if any.
allowed_room_ids:
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:
type: array
items:
Expand Down

0 comments on commit fff5f87

Please sign in to comment.