diff --git a/data/event-schemas/schema/m.room.name.yaml b/data/event-schemas/schema/m.room.name.yaml index c8d462b4..e21615ba 100644 --- a/data/event-schemas/schema/m.room.name.yaml +++ b/data/event-schemas/schema/m.room.name.yaml @@ -4,16 +4,19 @@ $schema: https://json-schema.org/draft/2020-12/schema allOf: - $ref: core-event-schema/state_event.yaml description: |- - A room has an opaque room ID which is not human-friendly to read. A room - alias is human-friendly, but not all rooms have room aliases. The room name - is a human-friendly string designed to be displayed to the end-user. The - room name is not unique, as multiple rooms can have the same room name set. + A room has an opaque [room ID](/appendices#room-ids) which is not + human-friendly to read. A [room alias](appendices#room-aliases) is + human-friendly, but not all rooms have [room aliases](/client-server-api/#room-aliases). + The room name is a human-friendly string designed to be displayed to the + end-user. The room name is not unique, as multiple rooms can have the same + room name set. If a room has an `m.room.name` event with an absent, null, or empty `name` field, it should be treated the same as a room with no `m.room.name` event. An event of this type is automatically created when creating a room using - `/createRoom` with the `name` key. + [`/createRoom`](/client-server-api/#post_matrixclientv3createroom) with the + `name` key. properties: content: properties: