matrix-org / matrix-org/matrix-spec
Clarify access to listing members by guest users
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Both
(A): https://spec.matrix.org/unstable/client-server-api/#get_matrixclientv3roomsroomidmembers
(B): https://spec.matrix.org/unstable/client-server-api/#get_matrixclientv3roomsroomidjoined_members
Suggest you receive a 403 when You aren’t a member of the room.. This suggest to me that for these endpoints to work, you need to be a member of the room.
Upon testing against Synapse, I noticed (A) is allowed for guest users, but (B) isn't. This isn't clear in the current documentation.
Background: I was researching for a way for guest users to list room members. Based on the documentation I figured it wasn't possible, but then decided to give it a try nonetheless. For me, it's nice that A works, but it would help if it's documented accordingly
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
Read the specification sections for GET /rooms/{roomId}/members and GET /rooms/{roomId}/joined_members, linked in the issue, and compare their documented access requirements. The issue reports that Synapse permits guests to use the first endpoint but not the second; done means the documentation makes that distinction clear.
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
- Mostly clear
- Newbie friendliness
- 35/100