matrix-org / matrix-org/matrix-spec

In the /sync response tree: invite_state should just be state.

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

Nobody has claimed this yet.

A-Client-Server enhancement wart
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

In the `/sync` response tree https://matrix.org/docs/spec/client_server/unstable.html#get-matrix-client-r0-sync for invited rooms, the key `invite_state` is used rather than `state` which is otherwise used elsewhere.

This might have been chosen on purpose to indicate that invite state events may not be complete events. Nevertheless, the client knows they are interpreting state events under the `rooms.invite` object and has enough information to know this fact.

The different name for this key makes reusing the same code-paths for handling aspects of `/sync` more difficult for both client and server authors. It has been a surprise gotcha for me now, twice, on both ends.

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 with the linked `/sync` client-server specification section and inspect the invited-room response tree and nearby references to `invite_state`. Rename the key to `state` consistently where appropriate, then verify that the documented response structure and related references agree.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.