matrix-org / matrix-org/matrix-spec

Add endpoint for getting current read receipt location

Open
#250 1 comment 4 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

Currently clients must perform a `/sync` to get the read receipts for a room. This can be disastrous on performance when your client only cares about getting the read receipt for a specific user in a specific room.

It would be more beneficial to lightweight clients (bots, iot) if the homeserver provided a way to look up a user's read receipt (probably their own, in most cases). For a sample use case, a bot may be interested in whether or not it has already replied to a message because it does not have long-term storage of its own.

Possible endpoint: `GET /_matrix/client/r0/rooms/!myroom:domain.com/user/@travis:t2l.io/receipt/m.read`
Possible response:
```
{
"event_id": "$whatever:domain.com"
}
```

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 reviewing the proposed GET endpoint and its sample response in this issue, then check the surrounding Matrix client-server specification for how room, user, and receipt identifiers are defined. Done means the specification has an agreed endpoint and response for looking up a user's read receipt without performing /sync.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.