matrix-org / matrix-org/matrix-spec
definition of "unread count" in push gateway API does not match reality
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
The [`_matrix/push/v1/notify` endpoint](https://matrix.org/docs/spec/push_gateway/r0.1.1#post-matrix-push-v1-notify) includes a parameter `notification.counts.unread`, defined as "The number of unread messages a user has across all of the rooms they are a member of."
Since https://github.com/matrix-org/synapse/pull/793, Synapse has chosen to interpret this as "the number of rooms with unread messages".
Possibly the spec should be reworded to allow discretion on the part of the homeserver impl?
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
Read the push gateway specification for the _matrix/push/v1/notify endpoint, especially notification.counts.unread, and review the linked Synapse pull request #793 for the implementation context. Compare the stated definition with Synapse's room-based interpretation; done means reaching agreement on whether the specification should be reworded and updating its definition accordingly.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100