JSONSchema has an [[ https://json-schema.org/understanding-json-schema/reference/generic.html#annotations | examples annotation ]] that can be used to provide an data example that validates with the schema.
We currently use the examples in the test/event schema for the kubernetes eventgate readinessProbe.
Having explicit examples with each schema will make it easier to debug and test that different eventgate deployments will work with their expected schemas.
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | Ottomata | T185233 Modern Event Platform | |||
| Resolved | Ottomata | T201063 Modern Event Platform: Schema Repostories | |||
| Resolved | Ottomata | T206789 Modern Event Platform: Schema Registry: Implementation | |||
| Resolved | Ottomata | T251609 Automate ingestion and refinement into Hive of event data from Kafka using stream configs and canary/heartbeat events | |||
| Resolved | Ottomata | T242454 Add examples to all event schemas |
I wonder...maybe we should add example schema validation checking to jsonschema-tools! Then we could use CI to force folks to make sure they provide a valid example event for each schema version!
Change 604146 had a related patch set uploaded (by Ppchelko; owner: Ppchelko):
[schemas/event/primary@master] Add examples to mediawiki/user-blocks-change schema.
Change 604146 merged by Ottomata:
[schemas/event/primary@master] Add examples to mediawiki/user-blocks-change schema.
Change 604485 had a related patch set uploaded (by Ottomata; owner: Ottomata):
[schemas/event/primary@master] Add examples to mediawiki/revision/create schema
Change 604485 merged by Ottomata:
[schemas/event/primary@master] Add examples to mediawiki/revision/create schema
Change 608313 had a related patch set uploaded (by Ottomata; owner: Ottomata):
[schemas/event/primary@master] [WIP] Add examples for fragment and {api,cirrussearrch}/request a schemas
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608313
Change 608930 had a related patch set uploaded (by Ottomata; owner: Ottomata):
[schemas/event/primary@master] Add examples for some schemas
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608930
Change 608313 abandoned by Ottomata:
[WIP] Add examples for fragment and {api,cirrussearrch}/request a schemas
Reason:
We decided today to go with explicit examples for now. Perhaps in the future we will get more magical.
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608313
Change 608930 merged by Ottomata:
[schemas/event/primary@master] Add examples for some schemas
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608930
Change 608935 had a related patch set uploaded (by Ottomata; owner: Ottomata):
[schemas/event/primary@master] Add schema examples
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608935
Change 608935 merged by Ottomata:
[schemas/event/primary@master] Add schema examples
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608935
Change 608938 had a related patch set uploaded (by Ottomata; owner: Ottomata):
[schemas/event/primary@master] Add examples to mediawiki/page/* schemas
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608938
Change 608938 merged by Ottomata:
[schemas/event/primary@master] Add examples to mediawiki/page/* schemas
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608938
Change 608945 had a related patch set uploaded (by Ottomata; owner: Ottomata):
[schemas/event/primary@master] Add/update examples for mediawiki/{recentchange,user/blocks-change}
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608945
Change 608945 merged by Ottomata:
[schemas/event/primary@master] Add/update examples for mediawiki/{recentchange,user/blocks-change}
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608945
Change 608948 had a related patch set uploaded (by Ottomata; owner: Ottomata):
[schemas/event/primary@master] Add examples to mediawiki/revision/* schemas
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608948
Change 608948 merged by Ottomata:
[schemas/event/primary@master] Add examples to mediawiki/revision/* schemas
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608948
Change 608949 had a related patch set uploaded (by Ottomata; owner: Ottomata):
[schemas/event/primary@master] Add examples to change-prop/* and error schemas
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608949
Change 608949 merged by Ottomata:
[schemas/event/primary@master] Add examples to change-prop/* and error schemas
https://gerrit.wikimedia.org/r/c/schemas/event/primary/ /608949
Phew, ok! Should be done with schemas/event/primary! Now on to schemas/event/secondary repo.
Change 610152 had a related patch set uploaded (by Ottomata; owner: Ottomata):
[schemas/event/secondary@master] Add (and modify) examples for sesstion_tick and sparql/query
Change 610152 merged by Ottomata:
[schemas/event/secondary@master] Add (and modify) examples for sesstion_tick and sparql/query