matrix-org / matrix-org/matrix-spec
Room summary API is missing authentication options
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.18/client-server-api/#room-summaries
Issue
The room summary API is missing a lot of the clarity given by MSC3266, for example what MAY be done for unauthenticated requests and guidance on 403 and 404 for rooms which require authentication or a user does not have access to.
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 Room summaries section in the linked Matrix Client-Server API specification and compare it with MSC3266. Document the allowed unauthenticated requests and the expected 403 and 404 behavior for restricted or inaccessible rooms. Done means the specification provides the missing guidance consistently with the MSC.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100