matrix-org / matrix-org/matrix-spec

`include_redundant_members` "subsequent calls" bound is not clear

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

Nobody has claimed this yet.

clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

**Link to problem area**: https://spec.matrix.org/v1.2/client-server-api/#get_matrixclientv3roomsroomidmessages under state -> description

**Issue**
This doesn't clear up if this is about subsequent *identical* requests to the endpoint, or requests that're "walking" the messages history (by using `end` for the next `from`).

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 at the Matrix Client-Server API section for GET /_matrix/client/v3/rooms/{roomId}/messages, specifically the state description for include_redundant_members. Determine whether “subsequent calls” means identical requests or paginated history requests using end as the next from value, then clarify the specification wording so that distinction is unambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.