matrix-org / matrix-org/matrix-spec
Inconsistency on the presence of unread notifications counters in sync responses
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
The `/sync` response spec doesn't mention `unread_notifications` as required, but the "Receiving notifications" section states:
> Servers MUST include the number of unread notifications in a client's `/sync` stream
Which, afaiu, means that `unread_notifications` is required.
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 searching the specification for the `/sync` response definition and the “Receiving notifications” section. Compare the requirement for `unread_notifications` in both places, then make the wording consistent and verify that the specification no longer gives conflicting guidance.
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
- Clearly specified
- Newbie friendliness
- 38/100