matrix-org / matrix-org/matrix-spec
It's not clear if creation of a room constitutes as a "change" for room summary fields
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/v1.4/client-server-api/#get_matrixclientv3sync, under RoomSummary
Issue
Found while looking at https://github.com/matrix-org/complement/pull/551, complement seems to assert that a room creation equals as a "change" in summary fields, and then requires their presence in the rooms.join.<room>.summary bit.
Synapse disagrees, the spec is silent on this, only providing this bit:
If this field has not changed since the last sync, it may be omitted. Required otherwise.
The question is:
Does room creation (with a creation content containing invite and other related fields) count as a "change" in these fields? Does it mean it needs to be included with room joins and on room creation?
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
Start with the RoomSummary section of the Matrix Client-Server API specification and review the behavior asserted in complement PR 551. Compare that interpretation with Synapse's behavior and determine whether room creation counts as a summary-field change. Done means the specification explicitly resolves whether summary fields are required on room creation and joins.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100