matrix-org / matrix-org/matrix-spec
Rate limiting spec ambiguous
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
The specs state for every API endpoint if it is rate-limited or not. Example:
https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-register
But later in the specs it is stated that ...
> Homeservers SHOULD implement rate limiting to reduce the risk of being overloaded. If a request is refused due to rate limiting, it should return a standard error response of the form.
https://matrix.org/docs/spec/client_server/latest#rate-limiting
Does 12 override the specs of the endpoints that are not rate-limited? Or is rate-limiting in itself just a recommendation?
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 rate-limiting section and the POST /_matrix/client/r0/register endpoint in the linked Client-Server specification. Compare the endpoint's rate-limit statement with the general recommendation and review the existing five comments for context. Done means the specification clearly states how endpoint-specific wording relates to the general rate-limiting guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100