matrix-org / matrix-org/matrix-spec
We seem to have lost path/query parameter examples in the new spec.
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:
e.g. https://spec.matrix.org/unstable/client-server-api/#get_matrixclientv3useruseridfilterfilterid compared to https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-user-userid-filter-filterid The old spec shows an
Example request:
GET /_matrix/client/r0/user/%40alice%3Aexample.com/filter/66696p746572 HTTP/1.1
whereas the new spec shows nothing.
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 comparing the unstable endpoint at spec.matrix.org/.../get_matrixclientv3useruseridfilterfilterid with the older client_server/r0.6.1 endpoint linked in the issue. Check whether path and query parameter examples are missing elsewhere in the new spec, then restore the relevant examples; the work is done when the affected endpoints again show representative requests.
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
- Mostly clear
- Newbie friendliness
- 32/100