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.

Sign up for GitHub

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

Jump to bottom

Publish JSON schema to GitHub pages #226

Open
JamieMagee opened this issue Feb 21, 2024 · 2 comments · May be fixed by #232
Open

Publish JSON schema to GitHub pages #226

JamieMagee opened this issue Feb 21, 2024 · 2 comments · May be fixed by #232

Comments

@JamieMagee
Copy link

As far as I can see, the JSON schema is only available at https://raw.githubusercontent.com/ossf/osv-schema/main/validation/schema.json. But raw.githubusercontent.com isn't really designed to be used as a CDN, which means that putting it in a $schema property isn't appropriate.

Copying the schema as part of the GitHub pages deployment, to something like https://ossf.github.io/osv-schema/schema.json, would be better in the long run
@JamieMagee JamieMagee changed the title Publish JSON schema Publish JSON schema to GitHub pages Mar 19, 2024
@oliverchang
Copy link
Contributor

Thanks for the suggestion! Would you be open to submitting a PR for adding this to https://ossf.github.io/osv-schema/schema.json ?

JamieMagee added a commit to JamieMagee/osv-schema that referenced this issue Mar 21, 2024
@JamieMagee
Move schema.json from validation to docs
52b37d9 
This allows the JSON schema to be published alongside the rest of the documentation to GitHub pages. The schema will be available at https://ossf.github.io/osv-schema/schema.json.

Also created a symlink to the previous repository location of `validation/schema.json` in case anyone is already using that in a `$schema` property

Closes ossf#226

Signed-off-by: Jamie Magee <jamagee@microsoft.com>
JamieMagee added a commit to JamieMagee/osv-schema that referenced this issue Mar 21, 2024
@JamieMagee
Move schema.json from validation to docs
0be5288 
This allows the JSON schema to be published alongside the rest of the documentation to GitHub pages. The schema will be available at https://ossf.github.io/osv-schema/schema.json.

Also created a symlink to the previous repository location of `validation/schema.json` in case anyone is already using that in a `$schema` property

Closes ossf#226

Signed-off-by: Jamie Magee <jamagee@microsoft.com>
@JamieMagee JamieMagee linked a pull request Mar 21, 2024 that will close this issue
Open
@JamieMagee
Copy link
Author

@oliverchang I created #232

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Move schema.json from validation to docs JamieMagee/osv-schema
2 participants
@oliverchang @JamieMagee