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

SPDX 2.2.2 external reference category schema.json on 2.2.2 tag does not match documentation #869

Open
wterpstra opened this issue Nov 6, 2023 · 1 comment
Labels
doc improvement Area where the project documentation needs improvement
Milestone

Comments

@wterpstra
Copy link

wterpstra commented Nov 6, 2023

The spec is a bit weird about the external reference categories

When looking at the reference category documentation the following values are allowed: SECURITY | PACKAGE-MANAGER | PERSISTENT-ID | OTHER

If you have a look at the json schema in the v2.2.2 tag the allowed values are "OTHER", "SECURITY", "PACKAGE_MANAGER"

This was raised in #792. It was decided that both values should be read, but the hyphens are be preferred over underscores. However, the docs nor the schema state this.

In issue CycloneDX/cyclonedx-dotnet-library#267 (comment) @andreas-hilti found that there is a development branch with a schema file with updated enum values: "OTHER", "PERSISTENT-ID", "PERSISTENT_ID", "SECURITY", "PACKAGE-MANAGER", "PACKAGE_MANAGER"

I guess this means that the 2.2.2 schema got amended after the fact, which is fine i guess(?), but now it's inconsistent between the documentation and there are different schema files floating around.

What schema file should be used when validating, reading and writing SPDX files?
Should the docs be changed to include both hyphens and underscore values?

@goneall
Copy link
Member

goneall commented Nov 6, 2023

I would recommend using the draft schema. If we end up doing another dot release of SPDX 2, it will include a fully documented official fix - until then, I'll be using the draft schema.

@goneall goneall added this to the 2.3.1 milestone Aug 11, 2024
@bact bact added the doc improvement Area where the project documentation needs improvement label Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc improvement Area where the project documentation needs improvement
Projects
None yet
Development

No branches or pull requests

3 participants