matrix-org / matrix-org/matrix-spec

Consider moving unread_notifications into summary in /sync

Open
#476 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server enhancement
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

From MSC688

We add a new section to the /sync response for a given room called ‘summary’. This is similar to the ‘unread_notifications’ section; it’s used for updating the client whenever the aggregate information calculated about the room changes. (In fact, should we move unread_notifications into this summary section?)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading MSC688 and the current /sync response specification, focusing on the summary and unread_notifications sections. Determine whether the proposed move is accepted and what compatibility or protocol details it requires; done means the specification has a decided, consistent treatment of unread_notifications.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.