matrix-org / matrix-org/matrix-spec
Events in the Client-Server API appear to be missing 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.15/client-server-api/#mroomcreate
Issue
The schema describes the content, but all the other fields like event_id, room_id, etc are missing definitions.
We should either verbosely list all the fields all the time, or include a link to somewhere else in the spec that says "this is [an event]".
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 at the m.room.create section of the Client-Server API specification and inspect how the event schema documents content versus fields such as event_id and room_id. Determine whether the specification should list those fields or link to a shared event definition; done means the chosen approach consistently documents the missing fields.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100