matrix-spec/event-schemas
Kegan Dougal 365a9076b9 Add nested dict template support; Add x-pattern
For cases where event schema specify `patternProperties` it would be nice
to give that pattern a "human-readable" form rather than a raw regex. This
is now supported by specifying `x-pattern` in the value part of the specified
pattern e.g. `patternProperties:{ "^.*":{ x-pattern: "$THING", ... } }`

Templating had limited record type descriptions limited to value primitives
e.g. `{string: integer}`. It now supports inspecting the values recursively
if the value is `object`.

Updated `m.receipt` to take both these points into account to make it read
better. Tweak receipt module text.
2015-10-01 12:11:26 +01:00
..
examples/v1 Merge pull request #27 from matrix-org/receipts 2015-09-10 16:18:19 +01:00
schema/v1 Add nested dict template support; Add x-pattern 2015-10-01 12:11:26 +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 Namespace all the things to v1. 2015-05-19 15:28:08 +01:00

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