matrix-org / matrix-org/matrix-spec
Review swagger for /sync
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
It is reportedly contradicting itself all over
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 locating the Swagger/OpenAPI documentation for the /sync endpoint and compare its sections for contradictions. Review the endpoint's request and response descriptions, then update the documentation so its statements are consistent throughout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100