matrix-org / matrix-org/matrix-spec

M_BAD_JSON vs M_INVALID_PARAM

Open
#786 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

**Link to problem area**: https://matrix.org/docs/spec/client_server/r0.6.1#api-standards

**Issue**

What is the difference between `M_BAD_JSON` and `M_INVALID_PARAM`? It seems that both can be used for invalid request parameters. Is the former for request-body parameters and the latter for query-string parameters?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the API standards section linked in the issue and compare the definitions and examples for M_BAD_JSON and M_INVALID_PARAM. Clarify whether the distinction depends on request-body versus query-string parameters, or document the actual boundary between them. Done means the specification answers the reported ambiguity.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.