-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: json schema for version 0.2.0 #45
base: main
Are you sure you want to change the base?
Conversation
c7db4d7
to
ab199a0
Compare
IMO it clearly is, as it also helps to auto-generate code for writing out VEX documents in different programming languages. |
Hey @StefanFl thanks a lot for this contribution it is of course super valuable! The JSON schema is something we've been meaning to write for a while now. Let me take a look at it and I'll add some early comments. |
11b60e1
to
c9aa934
Compare
I have changed some formats to from |
@sschuberth , @puerco There is one thing in the specification I don't understand: According to https://github.com/openvex/spec/blob/main/OPENVEX-SPEC.md#component-fields the fields |
Just guessing, I believe you must have at least on of these, as either single one should be enough to uniquely identify a component. |
At least one of I can implement this in the JSON Schema, but this would be more strict than the specification. |
Now at least one of |
Signed-off-by: Stefan Fleckenstein <stefan.fleckenstein@maibornwolff.de>
Signed-off-by: Stefan Fleckenstein <stefan.fleckenstein@maibornwolff.de>
Signed-off-by: Stefan Fleckenstein <stefan.fleckenstein@maibornwolff.de>
Signed-off-by: Stefan Fleckenstein <stefan.fleckenstein@maibornwolff.de>
…ponents and subcomponents Signed-off-by: Stefan Fleckenstein <stefan.fleckenstein@maibornwolff.de>
Signed-off-by: Stefan Fleckenstein <stefan.fleckenstein@maibornwolff.de>
98c6a17
to
7b78cf1
Compare
I have made a small fix. From "either a machine readable |
And I have included a reference to the JSON Schema in the README. From my point of view the PR is ready to be merged after your review. |
Just for the record, I was running the schema through a code generator for Kotlin, which created compilable code, so I guess the schema is syntactically valid 😺 |
Hi guys, anything you need from me to get the pull request accepted? |
JSON Schema is a great way to check if an OpenVEX document is compliant with the specification.
This is still a draft pull request, because: