Skip to content

Describe behaviour when the topic key is falsey in a m.room.topic event. #2068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 15, 2025
Merged

Describe behaviour when the topic key is falsey in a m.room.topic event. #2068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97dfa16
Describe behaviour when the `topic` key is falsey in a m.room.topic e…
Half-Shot Jan 31, 2025
695a977
Create 2068.clarification
Half-Shot Jan 31, 2025
a8e5c0e
improve wording
Half-Shot Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2068.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify behaviour when the `topic` key of a `m.room.topic` event is absent, null, or empty.
9 changes: 8 additions & 1 deletion data/event-schemas/schema/m.room.topic.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
---
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.'
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 the `topic` property is absent, null, or empty then the topic is unset. In other words,
an empty `topic` property effectively resets the room to having no topic.
Comment on lines +10 to +11
Copy link
Contributor

@Johennes Johennes Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm slightly confused about the absent / null part of this. topic is labeled as required. So I think it could at most be an empty string?

Copy link
Member

@richvdh richvdh Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could have been redacted. Or received over federation from a server that doesn't enforce the presence of the "required" properties.

Copy link
Contributor

@Johennes Johennes Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh right. I hadn't thought about redactions.

properties:
content:
properties:
Expand Down