matrix-org / matrix-org/matrix-spec
Clarify the responses that should be given when a request is missing arguments
Open
Nobody has claimed this yet.
A-Client-Server
clarification
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Dendrite seems to prefer a 400 `M_MISSING_ARGUMENTS` while Synapse goes for the 500 `M_UNKNOWN` route. A consistent error would be nice not only amoung the 2 projects, but in the spec as well.
Applies to all APIs, not just c2s.
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
Compare the missing-argument behavior described for Dendrite and Synapse, then review the Matrix specification's API requirements. Decide which response should be normative for all APIs and document the resulting status and error consistently.
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