matrix-org / matrix-org/matrix-spec
Optional or required properties in data/api/client-server/definitions/event.yaml
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
https://github.com/matrix-org/matrix-doc/blob/master/data/api/client-server/definitions/event.yaml
Some descriptions start with Optional., others don't. I would assume that the other fields are required. However, the event_id description contains if applicable, so it seems optional too.
This file has no required section to specify whether parameters are required or optional in a machine-readable way. No required section means all parameters are optional, but I don't think this is intentional, because data/event-schemas/schema/core-event-schema/event.yaml says all events must have content and type.
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 comparing data/api/client-server/definitions/event.yaml with data/event-schemas/schema/core-event-schema/event.yaml, especially the required fields and the event_id description. Determine which event properties are required or optional, then make the API definition express that consistently in machine-readable form and verify that the schema references agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100