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

ExternalReference ReferenceCategory: discrepancy between v2.2.2 JSON schema file and and docs #868

Closed
wterpstra opened this issue Nov 2, 2023 · 1 comment

Comments

@wterpstra
Copy link

wterpstra commented Nov 2, 2023

I raised an issue with CycloneDX around the way the ReferenceCategory of an ExternalReference is handled. During the investigation a discrepancy between the documentation and the schema file was found:

Here for version 2.2.2 the ExternalReference ReferenceCategory the values OTHER, SECURITY and PACKAGE_MANAGER are allowed:

"referenceCategory" : {
"description" : "Category for the external reference",
"type" : "string",
"enum" : [ "OTHER", "SECURITY", "PACKAGE_MANAGER" ]
},

However, in the 2.2.2 documentation the values SECURITY, PACKAGE-MANAGER , PERSISTENT-ID and OTHER are allowed. Note the difference between the dash and underscore for the package manager value and the lack of the PERSISTENT-ID in the schema.

The 2.3 schema does have these values:

"referenceCategory" : {
"description" : "Category for the external reference",
"type" : "string",
"enum" : [ "OTHER", "PERSISTENT-ID", "SECURITY", "PACKAGE-MANAGER" ]
},

So maybe while writing the documentation for version 2.2.2 the values from version 2.3 were used?

What should the correct values be?

@wterpstra wterpstra changed the title ExternalReference ReferenceCategory: discrepancy between JSON schema files and and docs ExternalReference ReferenceCategory: discrepancy between v2.2.2 JSON schema file and and docs Nov 2, 2023
@wterpstra
Copy link
Author

Never mind, this is a duplicate of #798 and #792

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

No branches or pull requests

1 participant