matrix
/
matrix-doc
mirror of https://github.com/matrix-org/matrix-doc.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
matrix-doc/event-schemas
History
Daniel Wagner-Hall b7355b0fa5 Merge pull request #117 from matrix-org/daniel/jenkins 
Give useful error if z-schema is missing
 		2015-10-19 13:24:00 +01:00
..
examples/v1 Add m.room.avatar 2015-10-19 10:46:07 +01:00
schema/v1 Add m.room.avatar 2015-10-19 10:46:07 +01:00
README.md Namespace all the things to v1. 2015-05-19 15:28:08 +01:00
check.sh Give useful error if z-schema is missing 2015-10-19 12:36:49 +01:00
check_examples.py Skip files that start with ".", e.g. vim swp files. 2015-09-21 15:05:10 +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