matrix-org / matrix-org/matrix-spec
Non-empty responses upon successful PUT
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
According to the definition of an HTTP PUT in [MDN web docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT), PUT should not return data in the response body upon a successful request.
The Client Server API specifies Response body parameters for the following PUT requests:
- [6.4.1](https://matrix.org/speculator/spec/HEAD/client_server/unstable.html#put-matrix-client-r0-rooms-roomid-state-eventtype-statekey)
- [6.4.2](https://matrix.org/speculator/spec/HEAD/client_server/unstable.html#put-matrix-client-r0-rooms-roomid-state-eventtype)
- [6.4.3](https://matrix.org/speculator/spec/HEAD/client_server/unstable.html#put-matrix-client-r0-rooms-roomid-send-eventtype-txnid)
- [6.5.2.1](https://matrix.org/speculator/spec/HEAD/client_server/unstable.html#put-matrix-client-r0-rooms-roomid-redact-eventid-txnid)
Should these be changed to GETs or POSTs?
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 reviewing the MDN PUT definition and the Client Server API sections 6.4.1, 6.4.2, 6.4.3, and 6.5.2.1 named in the issue. Determine the intended response-body behavior and whether the specification should change the methods or response parameters; the work is done when the decision is reflected consistently in those sections.
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