Best practices for CI/CD testing of JSON schema files

[kdaily]

Starting a discussion around best practices for CI/CD-related issues on schema files. I've enabled Travis on one of my schema repositories, and am only currently linting (using the same original definition as done in this repo).

What are some other things that we should be doing? What are the options for writing tests?

[karawoo]

Good question @kdaily. Assuming you are talking about JSON Schemas (and not schema.org schemas or the current synapse annotations schema format), the first thing that leaps to mind is validating the schema against its meta-schema.

[kdaily]

Thanks for the clarifying question. Correct, I do mean JSON schemas. As an example, this one for VEO-IBD generated by myself and @cw-dvr8. In this case, I don't think there is a meta-schema, as we authored this directly?

[karawoo]

I meant validating it against the draft-07 (or whichever draft you're using) JSON Schema specification, to ensure that it is a valid schema.

[kdaily]

Got it! Good suggestion. I tried doing this using ajv compile but my schema has remote references, which isn't supported in the ajv CLI tool. :(

[karawoo]

Ah that is a big bummer. I wonder if we could get a contribution in to ajv-cli...

[kdaily]

It's an old issue (2017):

ajv-validator/ajv-cli#29