matrix-org / matrix-org/matrix-spec

Clarify differences between `/devices` and `/keys/query`

Open Beginner friendly
#1,539 1 comment 1 reaction 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

Both POST /keys/query and GET /devices return a list of devices, so it's not entirely clear what the differences are.

The primary differences are:

  • /keys/query returns only those devices which have uploaded encryption keys, whereas /devices returns all devices. This in particular is slightly subtle and the spec makes no reference to it.
  • /devices cannot be used to query the device list of another user (it is strictly for the use of the local user to populate a "where am I logged in?" dialogue) whereas /keys/query can be used to get device information for other users

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 comparing the linked POST /keys/query and GET /devices sections in the Matrix client-server specification. Clarify that /keys/query returns only devices with uploaded encryption keys and can query other users, while /devices returns all devices for the local user. Done when these distinctions are explicit in the specification.

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
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.