matrix-org / matrix-org/matrix-spec
Should we version per-event event schemas? (SPEC-338)
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Currently we have no way of adding fields into something like m.room.message in a client-friendly way, short of the client looking at what fields are present and guessing wildly as to what 'version' of the event schema the event was actually meant to represent. We should presumably encourage or even mandate that all events have a v:1 style key to help for disambiguation like this. We could add these incrementally as required, perhaps.
(Imported from https://matrix.org/jira/browse/SPEC-338)
(Reported by @ara4n)
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 by reviewing how the Matrix specification currently defines m.room.message and other event schemas, then compare how clients identify event structure today. The work is complete when the specification records a clear decision on whether events should carry a v:1-style schema version and what scope of changes that decision covers.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100