Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

VEX schema/spec version should be a field in the metadata #20

Closed
lumjjb opened this issue Feb 15, 2023 · 4 comments
Closed

VEX schema/spec version should be a field in the metadata #20

lumjjb opened this issue Feb 15, 2023 · 4 comments

Comments

@lumjjb
Copy link
Contributor

lumjjb commented Feb 15, 2023

Currently there is no way to specify the current version of spec/schema used. Given that we most likely will have iterations and newer versions, we should encode it so that tooling can use it in the appropriate way.

This proposal is to add a field in Statement and Document to encode a VEX spec version.

@lumjjb
Copy link
Contributor Author

lumjjb commented Mar 6, 2023

@luhring @puerco @rnjudge @wagoodman thoughts?

@puerco
Copy link
Member

puerco commented Mar 6, 2023

I would not add it at the statement level because I think one document is expected to be all in one version. But moving forward the context uri will be versioned to do exactly that. I'm planning to do a final pass once the VEX Minimum Elements document is officially published and freeze the spec as v1.0.0.
After that I will update the context URL to start versioning it. WDYT?

@lumjjb
Copy link
Contributor Author

lumjjb commented Mar 6, 2023

Yea that sounds good, we are exploring some usecases where a full document isn't necessary, but nonetheless we can still encode it as a document... so unless that pattern becomes more prevalent. i think this proposal for context uri is good

@puerco
Copy link
Member

puerco commented Aug 22, 2023

Since spec v0.2.0 the context in OpenVEX documents is now versioned 🎉

@puerco puerco closed this as completed Aug 22, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants