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

Add $id to validation/schema.json #52

Closed
joshbuker opened this issue Jun 27, 2022 · 4 comments · Fixed by #130
Closed

Add $id to validation/schema.json #52

joshbuker opened this issue Jun 27, 2022 · 4 comments · Fixed by #130

Comments

@joshbuker
Copy link
Contributor

joshbuker commented Jun 27, 2022

@oliverchang I'm not sure what the best place for that to live would be, worst case scenario we can point it at the raw link for the main branch (https://raw.githubusercontent.com/ossf/osv-schema/main/validation/schema.json).

Relates to #51 somewhat (aiding parsers in knowing when an object is OSV, and what to expect from said OSV).

@joshbuker
Copy link
Contributor Author

Oh, one aspect of this that actually would be directly relevant to #51 is including versioning in said schema reference.

This is valuable for any other schemas that would like to either use an explicit version of OSV (e.g. 1.0.0) or explicitly the latest.

@joshbuker
Copy link
Contributor Author

Perhaps the following?

@oliverchang
Copy link
Contributor

Thanks for raising this!

We can probably set this up to serve from https://ossf.github.io/osv-schema/ (rather than https://osv.dev), and track the different versions via branches/tags in the repo. We might need to tweak with the site generation (which is currently a Jekyll site) to do this, but I haven't looked too closely to figure out how feasible this is.

Would you like to take a stab at this?

@joshbuker
Copy link
Contributor Author

See also: google/osv.dev#1166

oliverchang pushed a commit that referenced this issue Apr 4, 2023
Fixes #52 

Per #132 (comment),
the OSV schema must be fully backwards interoperable, meaning using main
instead of a specific version tag is the sanest option.

---------

Signed-off-by: Josh Buker <[email protected]>
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.

2 participants