Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Dear JAMS maintainers,
I've been discussing the JAMS project with @marton-balazs-kovacs, and we saw that it would be useful to the tenzing project to have a flexible schema that allowed for self-description of authorship roles. That prompted me to take a look at the state of your project and suggest a JSON schema (interoperable with your preferred YAML approach) that allows for both machine-readability and human convenience.
Please let me know if this PR is useful to you, or if you have any questions regarding its details.
For a basic overview of how the schema works, and to experiment with what does and does not fit it, you can copy-paste the contents of either schema file (
schema_flat.json
orschema_relaxed.json
) into the online JSON schema validator and then paste the contents of one of the example JSON files (examples/json/flat.json
orexamples/json/nested.json
) into the right-hand box.You should see that the flat json validates against both schemas, while the nested one only validates against the relaxed schema.
You may notice the nested schema is easier to write.
Currently there's only rudiementary details in the
definitions
section of the schemas to describe the way the objects should be defined.All of this information has been appended to the readmes by editing
README.md
and including a newschema_meta_notes.md
readme file.Thanks,
Matt