mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-17 03:23:42 +01:00
We seem to have [updated this for m.room.name](https://github.com/matrix-org/matrix-spec/pull/1639) some years back but omitted it for topic.
31 lines
878 B
YAML
31 lines
878 B
YAML
---
|
|
allOf:
|
|
- $ref: core-event-schema/state_event.yaml
|
|
description: |-
|
|
A topic is a short message detailing what is currently being discussed in the room.
|
|
It can also be used as a way to display extra information about the room, which may not
|
|
be suitable for the room name.
|
|
The room topic can also be set when creating a room using `/createRoom` with the `topic` key.'
|
|
|
|
If a room has an `m.room.topic` event with an absent, null, or empty `topic`
|
|
field, it should be treated the same as a room with no `m.room.topic` event.
|
|
properties:
|
|
content:
|
|
properties:
|
|
topic:
|
|
description: The topic text.
|
|
type: string
|
|
required:
|
|
- topic
|
|
type: object
|
|
state_key:
|
|
description: A zero-length string.
|
|
pattern: '^$'
|
|
type: string
|
|
type:
|
|
enum:
|
|
- m.room.topic
|
|
type: string
|
|
title: Topic
|
|
type: object
|