Skip to content
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

Published schema for OpenVex #14

Closed
garethr opened this issue Feb 4, 2023 · 8 comments · Fixed by #45
Closed

Published schema for OpenVex #14

garethr opened this issue Feb 4, 2023 · 8 comments · Fixed by #45

Comments

@garethr
Copy link

garethr commented Feb 4, 2023

The specification is a good human readable document, but it's not machine readable.

It would be useful to have a standalone schema (for instance in JSON Schema) for the specification. This would:

  • Allow for standalone validation
  • Make strong schema versioning easier to reason about
  • Avoid some ambiguity in any human readable document like the current spec
  • Aid in building tools that implement the spec, including additional libraries beyond the Go implementation

Thoughts?

@luhring
Copy link
Contributor

luhring commented Feb 5, 2023

Great idea!

@puerco
Copy link
Member

puerco commented Feb 6, 2023

I have a draft of the schema and context but I have not pr'ed them yet because I'm waiting for the VEX document to get finalized. At least frozen.

@dlorenc
Copy link
Contributor

dlorenc commented Feb 6, 2023

I have a draft of the schema and context but I have not pr'ed them yet because I'm waiting for the VEX document to get finalized. At least frozen.

Seem safe to PR it at least!

@tschmidtb51
Copy link

Just a word of caution: A schema, even though it's a good start, won't be enough to ensure that OpenVEX documents are valid VEX documents - see the discussion in #19. You might need to check that the encapsulation document has the products listed...

@jspeed-meyers
Copy link
Contributor

jspeed-meyers commented Jun 13, 2023

@puerco, what happened to the draft of the schema and context? Did you already PR it and it just wasn't linked to this issue? In other words ( 😄 ), has this issue already been addressed and so can be closed?

@aamedina
Copy link

aamedina commented Aug 2, 2023

Would there be any interest in an RDF model for OpenVEX?

@aamedina
Copy link

aamedina commented Aug 2, 2023

Here is an experimental OWL ontology with links to SPDX 3 profiles if anyone cares to import it into Protege use the spdx ontologies in the resources/spdx folder https://github.com/aamedina/ssvc/blob/eec287d86e4021ba6b5fe642eed05f987283bdd4/resources/vex/openvex.ttl

@puerco
Copy link
Member

puerco commented Aug 2, 2023

@aamedina if there is a need, go for it! We will be updating the spec next week, so it should be based on that revision. Let's chat about it on the community call!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants