matrix-org / matrix-org/matrix-spec
Incorrect and unclear description of `prev_batch` usage for /sync
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
From the spec:
Finally, the response includes, for each room, a
prev_batchfield, which can be passed as astartparameter to the/rooms/<room_id>/messagesAPI to retrieve earlier messages.
[...]
prev_batch: A token that can be supplied to thefromparameter of the rooms/{roomId}/messages endpoint.
Two issues with this:
- It's not clearly defined what
dirone should request from/messages, using thisprev_batchtoken - There is no such thing as a
startparameter, like the first part of the quoted text claims (there's only such a property in the response); presumably, that was supposed to sayfromrather thanstart.
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
Open the specification section linked in the issue and locate the /sync room prev_batch description alongside the rooms/{roomId}/messages parameter documentation. Check the parameter names and determine how the required dir value should be documented; done means the text is accurate and unambiguous.
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
- 45/100