matrix-org / matrix-org/matrix-spec
All APIs should have a dedicated "Unsupported Endpoints" section
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Link to problem area:
- https://spec.matrix.org/v1.10/client-server-api/#common-error-codes (
M_UNRECOGNIZED) - https://spec.matrix.org/v1.10/identity-service-api/#standard-error-response (
M_UNRECOGNIZED)
Issue
A common thing I do is try to link to the 404/405 M_UNRECOGNIZED behaviour, but because it's buried in the "Common error codes", I need to include language to navigate the reader. Preferably, a section exists which can be directly linked to, like the following:
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 linked Common error codes and Standard error response sections containing M_UNRECOGNIZED, then compare the existing Unsupported endpoints and Unknown routes sections in the server-server, application-service, and push-gateway APIs. Add a directly linkable unsupported-endpoints section to each API that lacks one, with the relevant 404/405 M_UNRECOGNIZED behavior. Done means all APIs have a dedicated section.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100