matrix-org / matrix-org/matrix-spec
`join_authorised_via_users_server` insufficiently explained in the C2S spec
Nobody has claimed this yet.
- 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.2/client-server-api/#mroommember
- https://spec.matrix.org/v1.2/client-server-api/#restricted-rooms
**Issue**:
The `m.room.member` briefly mentions `join_authorised_via_users_server` but doesn't adequately explain how it works. Instead it advises to look at the [Restricted Rooms](https://spec.matrix.org/v1.2/client-server-api/#restricted-rooms) section for more information but there's no mention of `join_authorised_via_users_server` there at all.
Both the S2S spec and the [MSC3083](https://github.com/matrix-org/matrix-spec-proposals/blob/main/proposals/3083-restricted-rooms.md) contain more information about how `join_authorised_via_users_server` is supposed to work, so we likely need to lift some wording from there.
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
Compare the m.room.member and Restricted Rooms sections in the linked v1.2 Client-Server API specification with the corresponding Server-Server specification and MSC3083. Add the missing explanation of join_authorised_via_users_server and ensure the Restricted Rooms section covers it, then verify that the cross-references are accurate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100