matrix-org / matrix-org/matrix-spec
Helper API for setting up canonical aliases
Open
Nobody has claimed this yet.
A-Client-Server
enhancement
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Rather than requiring clients to remember to set a canonical alias, maybe we should have a helper API which creates a new alias and sets it as the canonical alias of the room if there is not one already. (Alternatively, perhaps PUT /directory/room/$alias could be updated to do so).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the issue's proposal for a helper API and the existing PUT /directory/room/$alias endpoint. Clarify whether the intended change is a new helper or altered PUT behavior, including when an alias becomes canonical. Done means the API behavior and corresponding Matrix specification changes are agreed and documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100