matrix-org / matrix-org/matrix-spec

How should m.room.canonical_alias be handled on room upgrade

Open
#2,142 2 comments 0 reactions 0 assignees View on GitHub
clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

**Link to problem area**: https://spec.matrix.org/v1.14/client-server-api/#server-behaviour-19

**Issue**

Step 4 of server behavior on the room upgrade endpoint is:

> Moves any local aliases to the new room.

The spec does not mention what should happen with `m.room.canonical_alias` explicitly. On synapse, it appears that local aliases are removed from `m.room.canonical_alias` on the old room, and added to `m.room.canonical_alias` on the new room.

Contributor guide

Open the contributing guide

Research direction

Start with the room upgrade endpoint's server behavior in the linked Matrix client-server API section, then inspect how the specification describes m.room.canonical_alias and local aliases. Confirm the intended behavior for the old and new rooms, and update the relevant specification text so the canonical-alias outcome is explicit.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.