matrix-doc/event-schemas
Kegan Dougal 66bbc30893 Update check.sh now that z-schema returns 1 on error (v3.10.2+) 2015-05-20 14:36:54 +01:00
..
examples/v1 Rename msgtype examples to have # separator 2015-05-20 12:52:52 +01:00
schema/v1 Remove newlines from json: move line wrapping to the template files. 2015-05-20 12:41:25 +01:00
README.md Namespace all the things to v1. 2015-05-19 15:28:08 +01:00
check.sh Update check.sh now that z-schema returns 1 on error (v3.10.2+) 2015-05-20 14:36:54 +01:00

README.md

Testing a schema

There are many JSON Schema validators you can use to validate incoming events. Not all of them support JSON Schema v4, and some of them have bugs which prevent $ref from being resolved correctly. For basic CLI testing, we recommend and have verified they work with the Node.js package z-schema:

 $ npm install -g z-schema
 $ z-schema schema/v1/m.room.message examples/v1/m.room.message_m.text
 schema validation passed
 json #1 validation passed