docs-matrix-spec/data/event-schemas/schema/m.space.parent.yaml
Travis Ralston 9af83dfd41
Add Spaces to the spec (#3610)
* First iteration of specifying Spaces

MSCs:
* https://github.com/matrix-org/matrix-doc/pull/3288
* https://github.com/matrix-org/matrix-doc/pull/2946
* https://github.com/matrix-org/matrix-doc/pull/1772

Note that this makes modifications to the underlying MSCs as well. These are intended to be minor edits to aid clarity/accuracy of the MSCs, as per the proposal process. Functionally, clients and servers might need to change their behaviour slightly as is expected of implementing this stuff early. Synapse has these changes (alongside backwards compatibility) here: https://github.com/matrix-org/synapse/pull/11667

* add changelogs

* Accuracy per review

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* fully prefix new endpoints

* Fully prefix endpoint in 3616 too

* Fix ordering example

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2022-01-17 10:03:14 -07:00

32 lines
964 B
YAML

---
allOf:
- $ref: core-event-schema/state_event.yaml
description: Defines the relationship of a room to a parent space-room.
properties:
content:
properties:
via:
type: array
description: |-
A list of servers to try and join through. See also: [Routing](/appendices/#routing).
When not present or invalid, the room is not considered to be part of the parent space.
items:
type: string
canonical:
type: boolean
description: |-
Optional (default `false`) flag to denote this parent is the primary parent for the room.
When multiple `canonical` parents are found, the lowest parent when ordering by room ID
lexicographically by Unicode code-points should be used.
type: object
state_key:
description: The parent room ID.
type: string
type:
enum:
- m.space.parent
type: string
title: Room space parent
type: object