matrix-org / matrix-org/matrix-spec
Lack of clarity about device-list updates
- 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.4/server-server-api/#device-management
**Issue**
The "Device management" section says:
> If a server receives an EDU which refers to a `prev_id` it does not recognise, it must resynchronise its list by calling the `/user/keys/query API` and resume the process. The response contains a `stream_id` which should be used to correlate with subsequent `m.device_list_update` EDUs.
The `/user/keys/query API` could do with being a link, but it appears to refer to https://spec.matrix.org/v1.4/server-server-api/#post_matrixfederationv1userkeysquery. However, that API does not return a `stream_id` field, according to the spec. So... how does this work?
Contributor guide
Research direction
Read the Device management section and the linked POST /_matrix/federation/v1/user/keys/query API definition in the Matrix server-server specification. Check whether the documented response and stream_id correlation behavior agree, then clarify the link and wording so the resynchronization process is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100