matrix-org / matrix-org/matrix-spec
/join/{roomId} mixes query-params and POST request
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
[/_matrix/client/r0/join/{roomIdOrAlias}](https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-join-roomidoralias) is a POST request which also specifies that `server_name` can be passed via query-parameters. This sort of mixing of query-parameters with params passed in the request body is a bit odd.
(It turns out that one reason it was done this way was because synapse naughtily uses the /join request body as the content of the join event: https://github.com/matrix-org/synapse/issues/8763)
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 by reading the Matrix client-server specification for POST /_matrix/client/r0/join/{roomIdOrAlias}, including how server_name is passed. Review the linked Synapse issue for the stated reason behind the current behavior. Done means reaching and documenting a decision for how this endpoint should handle the parameter and request body.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100