update schema docs for CPE

[zmanion]

Proposed resolution for #388.

[jgamblin]

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]

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]

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

[zmanion]

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.

[zmanion]

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

[zmanion]

I dropped the change that added version to the schema. We should discuss this separately.

Previews:

https://zmanion.github.io/cve-schema/schema/docs/

https://zmanion.github.io/cve-schema/schema/docs/mindmap.html

@ccoffin I think this is ready

[zmanion]

To clean up a weird dangling commit I deleted my GitHub fork. Will submit a new PR.