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
Mark Haines 2efadea583 Merge branch 'master' into markjh/document_v1_rooms_api 2015-09-21 16:35:31 +01:00
..
examples/v1 Merge pull request #27 from matrix-org/receipts 2015-09-10 16:18:19 +01:00
schema/v1 Update the docs for room v1 api 2015-09-18 17:58:44 +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
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