matrix-org / matrix-org/matrix-spec
Clarify PUT /state event endpoint have special behaviour around `m.room.member`
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.15/client-server-api/#put_matrixclientv3roomsroomidstateeventtypestatekey
Issue
The /state endpoint should clarify that m.room.member state event have special behaviour as per https://spec.matrix.org/v1.15/rooms/v11/#authorization-rules
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 PUT /state event endpoint section linked in the issue, then compare it with the linked room authorization rules for m.room.member. Update the endpoint documentation so its special behavior is explicitly described and consistent with those rules; done means a reader can understand the exception from the endpoint section alone.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100