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

update schema docs for CPE #389

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

zmanion
Copy link
Contributor

@zmanion zmanion commented Mar 3, 2025

Proposed resolution for #388.

zmanion added 2 commits March 3, 2025 12:23
Signed-off-by: Art Manion <zmanion@protonmail.com>
Signed-off-by: Art Manion <zmanion@protonmail.com>
@jgamblin
Copy link

jgamblin commented Mar 4, 2025

This looks like a small change but does this become schema 5.1.1?
If so should there be an archive of 5.1.0 made and put here?
https://github.com/CVEProject/cve-schema/tree/main/schema/archive

@zmanion
Copy link
Contributor Author

zmanion commented Mar 4, 2025

Good question, I've staged a v.5.1.0 archive copy (matching the content of the v.5.0 directory). We've got some cruft/duplication building up (like a collection of node_modules and a 2016 .xlsx) but I didn't go through everything carefully. It might make sense to keep the current node_modules but maybe not keep the archives of them?

Looks like we name/rename the archived schema files with their version, e.g., CVE_JSON_5.0_schema.json, but the currenet schema is named CVE_Record_Format.json.

Should we record the schema version in some way? If not by file name, then add a version key/value?

"schema_version": "5.1.1",

Or if filenames, use symlinks?

CVE_Record_Format.json -> CVE_Record_Format_5.1.1.json
CVE_Record_Format_5.1.1.json
CVE_Record_Format_5.1.0.json
CVE_JSON_5.0_schema.json

@jgamblin
Copy link

jgamblin commented Mar 4, 2025

I think a version key in the schema makes a lot of sense.
Thanks for your work on keeping this repo in shape.

zmanion added 2 commits March 4, 2025 11:57
Signed-off-by: Art Manion <zmanion@protonmail.com>
Signed-off-by: Art Manion <zmanion@protonmail.com>
@zmanion
Copy link
Contributor Author

zmanion commented Mar 7, 2025

Discussed briefly at 2025-03-06 QWG meeting, one option is to not accept this PR and @ccoffin will run some other documentation update magic. Note that the documentation update tools in this repo need some minor edits if we intend to continue using them.

Copy link
Contributor Author

@zmanion zmanion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This commit (ff1dd11) should not be accepted, .oneOf[].properties.dataVersion already exists.

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 this pull request may close these issues.

2 participants