matrix-org / matrix-org/matrix-spec

`/joined_members` is not entirely clear about returning local room member objects

Open
#920 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

This was unclear, as conduit (accidentally) implemented it by returning global display-name/avatar information instead of room-local ones.

The spec says;

This API returns a map of MXIDs to member info objects for members of the room. The current user must be in the room for it to work, unless it is an Application Service in which case any of the AS's users must be in the room. This API is primarily for Application Services and should be faster to respond than /members as it can be implemented more efficiently on the server.

The relevant part is;

This API returns a map of MXIDs to member info objects for members of the room.

While this part may be reasonable on a double-take, I just wanted to note it here that it generated confusion (even for me, reading the first time) as what is exactly meant by that, in terms of returning room-local data vs global member data.

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 /joined_members definition in the Matrix specification and read the surrounding API text. Clarify that the returned member info objects contain room-local member data rather than global display-name or avatar data, while preserving the existing behavior and intent. Done means the wording cannot reasonably be read as referring to global member information.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.