matrix-org / matrix-org/matrix-spec
Inconsistent references to EventContent in /sync spec
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
In various places in the /sync endpoint spec for the CS API, EventContent is specified as the type for fields, but in other places it just says object, even though they all contain the same kind of thing (namely, varyingly-structured event content) and EventContent is not defined for that endpoint.
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
Review the /sync endpoint specification and search its EventContent references alongside fields currently typed as object. Determine the consistent representation and ensure EventContent is defined or referenced appropriately throughout the endpoint; done means the /sync spec no longer mixes equivalent types or uses an undefined endpoint type.
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