mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
6e16a19ac9
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
37 lines
1.1 KiB
YAML
37 lines
1.1 KiB
YAML
---
|
|
$schema: https://json-schema.org/draft/2020-12/schema
|
|
|
|
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
|