Develop a JSON Schema

[adamvoss]

I think the most important thing Open Recipe Format could do to encourage adoption would be to have tooling to support its users.

This is somewhat covered by TODO.rst:

• Add a syntax checker
• Add a reference parser

I do not think a syntax checker and custom parser are quite the right approach. When I was considering using Open Recipe Format, I went looking at how best to validate a file as being compliant and did not find good options. Long story short, this lead to me building tooling that could be used for this purpose.

If someone wants to apply them to this problem (despite building the tooling as a result of this problem, I do not currently have a need for Open Recipe Format) they would need to write a JSON Schema for the schema of Open Recipe Format.

Then the following would be available:

• Users can use the YAML extension for Visual Studio Code to write their recipes while getting editor help (in the way of feedback if an entry is invalid, completion has not been implemented [but could]) because they specify the Open Recipe Format schema should be used.
  • The extension is Language Server-based so someone could port it to other editors if desired.
• Users can validate their recipes via command line using the Polyglottal JSON Schma Validator (pajv).
• Users looking for tools other than the two just mentioned can check Schema Validation for YAML at JSON Schema Everywhere to see if anything else has been implemented.
• Users wanting to programatically interact with their recipes using an API other than their YAML parser can look can generate an API from the JSON Schema (ex. Java, C#)

[brmdv]

Liked this idea, and put something together: gist. I based it on the official reference, though there where some inconsistencies with the example files.

To test in VSCode, install the YAML-extension, and add this line to your preferences file:

"yaml.schemas": {
        "file://path/to/ORF_schema.json": "*yml"
},