docs-matrix-spec/data/event-schemas/schema/m.room.name.yaml
Aaron Raimist ac4a296e4c Remove unenforced size limit on room names (#3669)
Fixes #3641

The spec says the name field in m.room.name events must not exceed 255 bytes but no servers actually enforce this over the C-S API. Clients should probably already be truncating room names to an appropriate length for their user interface.

Signed-off-by: Aaron Raimist <aaron@raim.ist>
2022-05-09 01:28:17 -06:00

34 lines
992 B
YAML

---
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 with an `m.room.name` event with an absent, null, or empty
`name` field 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.
properties:
content:
properties:
name:
description: The name of the room.
type: string
required:
- name
type: object
state_key:
description: A zero-length string.
pattern: '^$'
type: string
type:
enum:
- m.room.name
type: string
title: RoomName
type: object