mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-10 21:44:11 +01:00
00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
35 lines
1.1 KiB
YAML
35 lines
1.1 KiB
YAML
---
|
|
allOf:
|
|
- $ref: core-event-schema/state_event.yaml
|
|
description: |-
|
|
This event is used to inform the room about which alias should be
|
|
considered the canonical one, and which other aliases point to the room.
|
|
This could be for display purposes or as suggestion to users which alias
|
|
to use to advertise and access the room.
|
|
properties:
|
|
content:
|
|
properties:
|
|
alias:
|
|
description: |
|
|
The canonical alias for the room. If not present, null, or empty the
|
|
room should be considered to have no canonical alias.
|
|
type: string
|
|
alt_aliases:
|
|
description: |
|
|
Alternative aliases the room advertises. This list can have aliases
|
|
despite the ``alias`` field being null, empty, or otherwise not present.
|
|
type: array
|
|
items:
|
|
type: string
|
|
type: object
|
|
state_key:
|
|
description: A zero-length string.
|
|
pattern: '^$'
|
|
type: string
|
|
type:
|
|
enum:
|
|
- m.room.canonical_alias
|
|
type: string
|
|
title: Informs the room as to which alias is the canonical one.
|
|
type: object
|