From a493acb489619ec51708019beaf7c85cab1afb9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Thu, 24 Oct 2024 16:53:45 +0200 Subject: [PATCH] Fix links in OpenAPI data MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Links that contain only a fragment are not resolved by Hugo so the final relative URL is wrong. They also cause problems for the OpenAPI definitions because these links are not edited in the dump-openapi script so they end up broken. Signed-off-by: Kévin Commaille --- data/api/client-server/account-data.yaml | 4 +-- data/api/client-server/appservice_ping.yaml | 4 +-- .../client-server/definitions/auth_data.yaml | 2 +- .../definitions/key_backup_session_data.yaml | 3 ++- .../megolm_export_session_data.yaml | 4 +-- .../definitions/timeline_batch.yaml | 2 +- data/api/client-server/old_sync.yaml | 4 +-- .../room_event_by_timestamp.yaml | 2 +- data/api/client-server/room_initial_sync.yaml | 4 +-- data/api/client-server/space_hierarchy.yaml | 12 ++++----- data/api/client-server/sync.yaml | 27 ++++++++++--------- data/api/client-server/whoami.yaml | 6 ++--- data/api/server-server/events.yaml | 4 +-- data/api/server-server/joins-v1.yaml | 2 +- data/api/server-server/space_hierarchy.yaml | 4 +-- .../schema/m.forwarded_room_key.yaml | 2 +- .../schema/m.key.verification.request.yaml | 3 ++- data/event-schemas/schema/m.room.create.yaml | 3 ++- .../schema/m.room.encrypted.yaml | 11 ++++---- data/event-schemas/schema/m.room.member.yaml | 2 +- ...om.message$m.key.verification.request.yaml | 2 +- data/event-schemas/schema/m.room_key.yaml | 2 +- .../schema/m.room_key_request.yaml | 4 +-- data/event-schemas/schema/m.secret.send.yaml | 3 ++- data/event-schemas/schema/m.space.child.yaml | 2 +- 25 files changed, 63 insertions(+), 55 deletions(-) diff --git a/data/api/client-server/account-data.yaml b/data/api/client-server/account-data.yaml index 8fda4c39..fea15d95 100644 --- a/data/api/client-server/account-data.yaml +++ b/data/api/client-server/account-data.yaml @@ -23,7 +23,7 @@ paths: Set some account data for the client. This config is only visible to the user that set the account data. The config will be available to clients through the top-level `account_data` field in the homeserver response to - [/sync](#get_matrixclientv3sync). + [/sync](/client-server-api/#get_matrixclientv3sync). operationId: setAccountData security: - accessTokenQuery: [] @@ -185,7 +185,7 @@ paths: description: |- Set some account data for the client on a given room. This config is only visible to the user that set the account data. The config will be delivered to - clients in the per-room entries via [/sync](#get_matrixclientv3sync). + clients in the per-room entries via [/sync](/client-server-api/#get_matrixclientv3sync). operationId: setAccountDataPerRoom security: - accessTokenQuery: [] diff --git a/data/api/client-server/appservice_ping.yaml b/data/api/client-server/appservice_ping.yaml index 5596119e..ed84a089 100644 --- a/data/api/client-server/appservice_ping.yaml +++ b/data/api/client-server/appservice_ping.yaml @@ -23,7 +23,7 @@ paths: connection works. description: |- This API asks the homeserver to call the - [`/_matrix/app/v1/ping`](#post_matrixappv1ping) endpoint on the + [`/_matrix/app/v1/ping`](/application-service-api/#post_matrixappv1ping) endpoint on the application service to ensure that the homeserver can communicate with the application service. @@ -71,7 +71,7 @@ paths: type: integer description: |- The duration in milliseconds that the - [`/_matrix/app/v1/ping`](#post_matrixappv1ping) + [`/_matrix/app/v1/ping`](/application-service-api/#post_matrixappv1ping) request took from the homeserver's point of view. required: - duration_ms diff --git a/data/api/client-server/definitions/auth_data.yaml b/data/api/client-server/definitions/auth_data.yaml index 691cdc65..0186b24e 100644 --- a/data/api/client-server/definitions/auth_data.yaml +++ b/data/api/client-server/definitions/auth_data.yaml @@ -21,7 +21,7 @@ properties: The authentication type that the client is attempting to complete. May be omitted if `session` is given, and the client is reissuing a request which it believes has been completed out-of-band (for example, - via the [fallback mechanism](#fallback)). + via the [fallback mechanism](/client-server-api/#fallback)). type: string session: description: The value of the session key given by the homeserver. diff --git a/data/api/client-server/definitions/key_backup_session_data.yaml b/data/api/client-server/definitions/key_backup_session_data.yaml index bc61bb30..e2579142 100644 --- a/data/api/client-server/definitions/key_backup_session_data.yaml +++ b/data/api/client-server/definitions/key_backup_session_data.yaml @@ -28,7 +28,8 @@ properties: items: type: string description: |- - Chain of Curve25519 keys through which this session was forwarded, via [m.forwarded_room_key](#mforwarded_room_key) events. + Chain of Curve25519 keys through which this session was forwarded, via [m.forwarded_room_key](/client-server-api/#mforwarded_room_key) + events. sender_key: type: string description: |- diff --git a/data/api/client-server/definitions/megolm_export_session_data.yaml b/data/api/client-server/definitions/megolm_export_session_data.yaml index f5d1e409..ac4e4945 100644 --- a/data/api/client-server/definitions/megolm_export_session_data.yaml +++ b/data/api/client-server/definitions/megolm_export_session_data.yaml @@ -21,8 +21,8 @@ allOf: The format used to encode a Megolm session key for export. This is similar to the format before encryption used for the session keys - in [Server-side key backups](#server-side-key-backups) but adds the - `room_id` and `session_id` fields. + in [Server-side key backups](/client-server-api/#server-side-key-backups) + but adds the `room_id` and `session_id` fields. properties: room_id: type: string diff --git a/data/api/client-server/definitions/timeline_batch.yaml b/data/api/client-server/definitions/timeline_batch.yaml index 1c4ba40e..5b95f583 100644 --- a/data/api/client-server/definitions/timeline_batch.yaml +++ b/data/api/client-server/definitions/timeline_batch.yaml @@ -19,7 +19,7 @@ properties: type: boolean prev_batch: description: A token that can be supplied to the `from` parameter of the - [`/rooms//messages`](#get_matrixclientv3roomsroomidmessages) + [`/rooms//messages`](/client-server-api/#get_matrixclientv3roomsroomidmessages) endpoint in order to retrieve earlier events. If no earlier events are available, this property may be omitted from diff --git a/data/api/client-server/old_sync.yaml b/data/api/client-server/old_sync.yaml index a1d0f497..0a3c0439 100644 --- a/data/api/client-server/old_sync.yaml +++ b/data/api/client-server/old_sync.yaml @@ -173,7 +173,7 @@ paths: description: |- A token which correlates to the start of `chunk`. Can be passed to - [`/rooms//messages`](#get_matrixclientv3roomsroomidmessages) + [`/rooms//messages`](/client-server-api/#get_matrixclientv3roomsroomidmessages) to retrieve earlier events. If no earlier events are available, this property may be omitted from @@ -183,7 +183,7 @@ paths: description: |- A token which correlates to the end of `chunk`. Can be passed to - [`/rooms//messages`](#get_matrixclientv3roomsroomidmessages) + [`/rooms//messages`](/client-server-api/#get_matrixclientv3roomsroomidmessages) to retrieve later events. chunk: type: array diff --git a/data/api/client-server/room_event_by_timestamp.yaml b/data/api/client-server/room_event_by_timestamp.yaml index 232950f5..1ab52cb9 100644 --- a/data/api/client-server/room_event_by_timestamp.yaml +++ b/data/api/client-server/room_event_by_timestamp.yaml @@ -30,7 +30,7 @@ paths: to ask other servers for a suitable event. After calling this endpoint, clients can call - [`/rooms/{roomId}/context/{eventId}`](#get_matrixclientv3roomsroomidcontexteventid) + [`/rooms/{roomId}/context/{eventId}`](/client-server-api/#get_matrixclientv3roomsroomidcontexteventid) to obtain a pagination token to retrieve the events around the returned event. The event returned by this endpoint could be an event that the client diff --git a/data/api/client-server/room_initial_sync.yaml b/data/api/client-server/room_initial_sync.yaml index 6b34f331..7b70bacb 100644 --- a/data/api/client-server/room_initial_sync.yaml +++ b/data/api/client-server/room_initial_sync.yaml @@ -54,7 +54,7 @@ paths: type: string description: |- A token which correlates to the start of `chunk`. Can be passed to - [`/rooms//messages`](#get_matrixclientv3roomsroomidmessages) + [`/rooms//messages`](/client-server-api/#get_matrixclientv3roomsroomidmessages) to retrieve earlier events. If no earlier events are available, this property may be omitted from @@ -63,7 +63,7 @@ paths: type: string description: |- A token which correlates to the end of `chunk`. Can be passed to - [`/rooms//messages`](#get_matrixclientv3roomsroomidmessages) + [`/rooms//messages`](/client-server-api/#get_matrixclientv3roomsroomidmessages) to retrieve later events. chunk: type: array diff --git a/data/api/client-server/space_hierarchy.yaml b/data/api/client-server/space_hierarchy.yaml index 8378aee0..6329495c 100644 --- a/data/api/client-server/space_hierarchy.yaml +++ b/data/api/client-server/space_hierarchy.yaml @@ -26,8 +26,8 @@ paths: Where a child room is unknown to the local server, federation is used to fill in the details. The servers listed in the `via` array should be contacted to attempt to fill in missing rooms. - Only [`m.space.child`](#mspacechild) state events of the room are considered. Invalid child - rooms and parent events are not covered by this endpoint. + Only [`m.space.child`](/client-server-api/#mspacechild) state events of the room are considered. + Invalid child rooms and parent events are not covered by this endpoint. operationId: getSpaceHierarchy security: - accessTokenQuery: [] @@ -44,8 +44,8 @@ paths: name: suggested_only description: |- Optional (default `false`) flag to indicate whether or not the server should only consider - suggested rooms. Suggested rooms are annotated in their [`m.space.child`](#mspacechild) event - contents. + suggested rooms. Suggested rooms are annotated in their [`m.space.child`](/client-server-api/#mspacechild) + event contents. example: true schema: type: boolean @@ -103,8 +103,8 @@ paths: children_state: type: array description: |- - The [`m.space.child`](#mspacechild) events of the space-room, represented - as [Stripped State Events](#stripped-state) with an added `origin_server_ts` key. + The [`m.space.child`](/client-server-api/#mspacechild) events of the space-room, represented + as [Stripped State Events](/client-server-api/#stripped-state) with an added `origin_server_ts` key. If the room is not a space-room, this should be empty. items: diff --git a/data/api/client-server/sync.yaml b/data/api/client-server/sync.yaml index efe36c5c..1122f28f 100644 --- a/data/api/client-server/sync.yaml +++ b/data/api/client-server/sync.yaml @@ -223,8 +223,8 @@ paths: The new ephemeral events in the room (events that aren't recorded in the timeline or state of the room). In this version of the spec, these are - [typing notification](#typing-notifications) and - [read receipt](#receipts) events. + [typing notification](/client-server-api/#typing-notifications) + and [read receipt](/client-server-api/#receipts) events. allOf: - $ref: definitions/event_batch.yaml account_data: @@ -245,7 +245,7 @@ paths: If `unread_thread_notifications` was specified as `true` on the `RoomEventFilter`, these counts will only be for the main timeline rather than all events in the room. - See the [threading module](#threading) for more information. + See the [threading module](/client-server-api/#threading) for more information. x-changedInMatrixVersion: "1.4": | Updated to reflect behaviour of having `unread_thread_notifications` as `true` in @@ -265,8 +265,8 @@ paths: type: object description: |- If `unread_thread_notifications` was specified as `true` on the `RoomEventFilter`, - the notification counts for each [thread](#threading) in this room. The object is - keyed by thread root ID, with values matching `unread_notifications`. + the notification counts for each [thread](/client-server-api/#threading) in this room. + The object is keyed by thread root ID, with values matching `unread_notifications`. If a thread does not have any notifications it can be omitted from this object. If no threads have notification counts, this whole object can be omitted. @@ -302,12 +302,13 @@ paths: title: InviteState type: object description: |- - The [stripped state](#stripped-state) of a room that the user has been invited - to. + The [stripped state](/client-server-api/#stripped-state) of a room that the user has + been invited to. properties: events: - description: The [stripped state events](#stripped-state) that form the invite - state. + description: |- + The [stripped state events](/client-server-api/#stripped-state) that form the + invite state. items: $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml type: array @@ -325,12 +326,14 @@ paths: knock_state: title: KnockState type: object - description: The [stripped state](#stripped-state) of a room that the user has + description: |- + The [stripped state](/client-server-api/#stripped-state) of a room that the user has knocked upon. properties: events: - description: The [stripped state events](#stripped-state) that form the knock - state. + description: |- + The [stripped state events](/client-server-api/#stripped-state) that form the + knock state. items: $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml type: array diff --git a/data/api/client-server/whoami.yaml b/data/api/client-server/whoami.yaml index 390fa773..8f4027e7 100644 --- a/data/api/client-server/whoami.yaml +++ b/data/api/client-server/whoami.yaml @@ -57,9 +57,9 @@ paths: x-addedInMatrixVersion: "1.2" type: boolean description: |- - When `true`, the user is a [Guest User](#guest-access). When - not present or `false`, the user is presumed to be a non-guest - user. + When `true`, the user is a [Guest User](/client-server-api/#guest-access). + When not present or `false`, the user is presumed to be a + non-guest user. examples: response: value: { diff --git a/data/api/server-server/events.yaml b/data/api/server-server/events.yaml index 30e22830..f61f6fe4 100644 --- a/data/api/server-server/events.yaml +++ b/data/api/server-server/events.yaml @@ -216,8 +216,8 @@ paths: using the `origin_server_ts` property, whether the returned event is closer to the requested timestamp than the closest event that it could find locally. If so, it should try to backfill this event via the - [`/event/{event_id}`](#get_matrixfederationv1eventeventid) endpoint so - that it is available to for a client to query. + [`/event/{event_id}`](/server-server-api/#get_matrixfederationv1eventeventid) + endpoint so that it is available to for a client to query. operationId: getEventByTimestamp security: - accessToken: [] diff --git a/data/api/server-server/joins-v1.yaml b/data/api/server-server/joins-v1.yaml index a361836c..9247626a 100644 --- a/data/api/server-server/joins-v1.yaml +++ b/data/api/server-server/joins-v1.yaml @@ -155,7 +155,7 @@ paths: The request is invalid, the room the server is attempting to join has a version that is not listed in the `ver` parameters, or the server was unable to validate - [restricted room conditions](#restricted-rooms). + [restricted room conditions](/server-server-api/#restricted-rooms). The error should be passed through to clients so that they may give better feedback to users. diff --git a/data/api/server-server/space_hierarchy.yaml b/data/api/server-server/space_hierarchy.yaml index 1b9ba99c..8394588b 100644 --- a/data/api/server-server/space_hierarchy.yaml +++ b/data/api/server-server/space_hierarchy.yaml @@ -75,7 +75,7 @@ paths: items: type: string description: |- - If the room is a [restricted room](#restricted-rooms), these are the room IDs which + If the room is a [restricted room](/server-server-api/#restricted-rooms), these are the room IDs which are specified by the join rules. Empty or omitted otherwise. children_state: type: array @@ -119,7 +119,7 @@ paths: items: type: string description: |- - If the room is a [restricted room](#restricted-rooms), these are the room IDs which + If the room is a [restricted room](/server-server-api/#restricted-rooms), these are the room IDs which are specified by the join rules. Empty or omitted otherwise. inaccessible_children: type: array diff --git a/data/event-schemas/schema/m.forwarded_room_key.yaml b/data/event-schemas/schema/m.forwarded_room_key.yaml index 10b8b652..101716a0 100644 --- a/data/event-schemas/schema/m.forwarded_room_key.yaml +++ b/data/event-schemas/schema/m.forwarded_room_key.yaml @@ -4,7 +4,7 @@ allOf: description: |- This event type is used to forward keys for end-to-end encryption. - It is encrypted as an `m.room.encrypted` event using [Olm](#molmv1curve25519-aes-sha2), + It is encrypted as an `m.room.encrypted` event using [Olm](/client-server-api/#molmv1curve25519-aes-sha2), then sent as a [to-device](/client-server-api/#send-to-device-messaging) event. properties: content: diff --git a/data/event-schemas/schema/m.key.verification.request.yaml b/data/event-schemas/schema/m.key.verification.request.yaml index 76ba618d..880d4900 100644 --- a/data/event-schemas/schema/m.key.verification.request.yaml +++ b/data/event-schemas/schema/m.key.verification.request.yaml @@ -5,7 +5,8 @@ allOf: description: |- Requests a key verification using to-device messaging. When requesting a key verification in a room, a `m.room.message` should be used, with - [`m.key.verification.request`](#mroommessagemkeyverificationrequest) as msgtype. + [`m.key.verification.request`](/client-server-api/#mroommessagemkeyverificationrequest) + as msgtype. properties: content: properties: diff --git a/data/event-schemas/schema/m.room.create.yaml b/data/event-schemas/schema/m.room.create.yaml index 1ca37865..19b2bae4 100644 --- a/data/event-schemas/schema/m.room.create.yaml +++ b/data/event-schemas/schema/m.room.create.yaml @@ -18,7 +18,8 @@ properties: type: string type: description: |- - Optional [room type](#types) to denote a room's intended function outside of traditional conversation. + Optional [room type](/client-server-api/#types) to denote a room's intended function outside of traditional + conversation. Unspecified room types are possible using [Namespaced Identifiers](/appendices/#common-namespaced-identifier-grammar). type: string diff --git a/data/event-schemas/schema/m.room.encrypted.yaml b/data/event-schemas/schema/m.room.encrypted.yaml index f608a6e2..6a5689ac 100644 --- a/data/event-schemas/schema/m.room.encrypted.yaml +++ b/data/event-schemas/schema/m.room.encrypted.yaml @@ -46,14 +46,15 @@ properties: "1.3": |- Previously this field was required, however given it offers no additional security or privacy benefit it has been deprecated for Megolm messages. - See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2) for more information. + See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2) for + more information. description: |- The Curve25519 key of the sender. Required (not deprecated) if not using Megolm. **Deprecated**: This field provides no additional security or privacy benefit for Megolm messages and must not be read from if the encrypted event is using Megolm. It should still be included on outgoing messages, however must not be - used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2) + used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2) for more information. device_id: type: string @@ -62,15 +63,15 @@ properties: "1.3": |- Previously this field was required for Megolm messages, however given it offers no additional security or privacy benefit it has been deprecated - for Megolm messages. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2) for - more information. + for Megolm messages. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2) + for more information. description: |- The ID of the sending device. **Deprecated**: This field provides no additional security or privacy benefit for Megolm messages and must not be read from if the encrypted event is using Megolm. It should still be included on outgoing messages, however must not be - used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2) + used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2) for more information. session_id: type: string diff --git a/data/event-schemas/schema/m.room.member.yaml b/data/event-schemas/schema/m.room.member.yaml index f2d297b5..8d212687 100644 --- a/data/event-schemas/schema/m.room.member.yaml +++ b/data/event-schemas/schema/m.room.member.yaml @@ -64,7 +64,7 @@ properties: type: string description: |- Usually found on `join` events, this field is used to denote which homeserver (through representation of a user with sufficient power level) - authorised the user's join. More information about this field can be found in the [Restricted Rooms Specification](#restricted-rooms). + authorised the user's join. More information about this field can be found in the [Restricted Rooms Specification](/client-server-api/#restricted-rooms). Client and server implementations should be aware of the [signing implications](/rooms/v8/#authorization-rules) of including this field in further events: in particular, the event must be signed by the server which diff --git a/data/event-schemas/schema/m.room.message$m.key.verification.request.yaml b/data/event-schemas/schema/m.room.message$m.key.verification.request.yaml index c0a0764c..43882ab9 100644 --- a/data/event-schemas/schema/m.room.message$m.key.verification.request.yaml +++ b/data/event-schemas/schema/m.room.message$m.key.verification.request.yaml @@ -3,7 +3,7 @@ allOf: - $ref: core-event-schema/room_event.yaml description: Requests a key verification in a room. When requesting a key verification - using to-device messaging, an event with type [`m.key.verification.request`](#mkeyverificationrequest) + using to-device messaging, an event with type [`m.key.verification.request`](/client-server-api/#mkeyverificationrequest) should be used. properties: content: diff --git a/data/event-schemas/schema/m.room_key.yaml b/data/event-schemas/schema/m.room_key.yaml index 34ceb9ae..c90b41b4 100644 --- a/data/event-schemas/schema/m.room_key.yaml +++ b/data/event-schemas/schema/m.room_key.yaml @@ -4,7 +4,7 @@ allOf: description: |- This event type is used to exchange keys for end-to-end encryption. - It is encrypted as an `m.room.encrypted` event using [Olm](#molmv1curve25519-aes-sha2), + It is encrypted as an `m.room.encrypted` event using [Olm](/client-server-api/#molmv1curve25519-aes-sha2), then sent as a [to-device](/client-server-api/#send-to-device-messaging) event. properties: content: diff --git a/data/event-schemas/schema/m.room_key_request.yaml b/data/event-schemas/schema/m.room_key_request.yaml index 9894456e..62b07a23 100644 --- a/data/event-schemas/schema/m.room_key_request.yaml +++ b/data/event-schemas/schema/m.room_key_request.yaml @@ -26,7 +26,7 @@ properties: x-changedInMatrixVersion: "1.3": |- Previously this field was required, however given it offers no additional - security or privacy benefit it has been deprecated. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2) + security or privacy benefit it has been deprecated. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2) for more information. description: |- The Curve25519 key of the device which initiated the session originally. @@ -34,7 +34,7 @@ properties: **Deprecated**: This field provides no additional security or privacy benefit and must not be read from. It should still be included on outgoing messages (if the event for which keys are being requested for *also* has a `sender_key`), - however must not be used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2) + however must not be used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2) for more information. session_id: type: string diff --git a/data/event-schemas/schema/m.secret.send.yaml b/data/event-schemas/schema/m.secret.send.yaml index ecf22183..a2cafb6d 100644 --- a/data/event-schemas/schema/m.secret.send.yaml +++ b/data/event-schemas/schema/m.secret.send.yaml @@ -4,7 +4,8 @@ allOf: description: |- Sent by a client to share a secret with another device, in response to an `m.secret.request` event. It must be encrypted as an `m.room.encrypted` event - using [Olm](#molmv1curve25519-aes-sha2), then sent as a to-device event. + using [Olm](/client-server-api/#molmv1curve25519-aes-sha2), then sent as a + to-device event. The `request_id` must match the ID previously given in an `m.secret.request` event. The recipient must ensure that this event comes from a device that the diff --git a/data/event-schemas/schema/m.space.child.yaml b/data/event-schemas/schema/m.space.child.yaml index c73d440f..2222b3a1 100644 --- a/data/event-schemas/schema/m.space.child.yaml +++ b/data/event-schemas/schema/m.space.child.yaml @@ -1,7 +1,7 @@ --- allOf: - $ref: core-event-schema/state_event.yaml -description: Defines the relationship of a child room to a space-room. Has no effect in rooms which are not [spaces](#spaces). +description: Defines the relationship of a child room to a space-room. Has no effect in rooms which are not [spaces](/client-server-api/#spaces). properties: content: properties: