matrix-org / matrix-org/matrix-spec
Should `full_state` in the `/sync` API include `invite` room state?
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Link to problem area**: https://spec.matrix.org/unstable/client-server-api/#get_matrixclientr0sync
**Issue**
The `full_state` parameter on `/sync` says it will give you all the state for the rooms that the user is a member of.
The question is whether this should include rooms that are `invite`, `knock` or `leave`.
(Synapse does not appear to include `invite` rooms, at least — I have not checked the other 2.)
I suppose it *does* say 'that the user is a member of' and it's my fault for not reading carefully, but it wouldn't hurt to spell it out in no uncertain terms.
(Personally I think it would make sense to include these, but perhaps the ship has sailed on that one, much to my chagrin...).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked Matrix client-server API section for /sync first, then compare its wording with the reported behavior for invite, knock, and leave rooms. After the intended semantics are decided, update that section to state explicitly whether full_state includes those membership states and verify that the wording resolves the ambiguity.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100