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 documentation not in sync with schema #872

Open
Moullisha opened this issue Dec 13, 2023 · 3 comments
Open

SPDX documentation not in sync with schema #872

Moullisha opened this issue Dec 13, 2023 · 3 comments
Milestone

Comments

@Moullisha
Copy link

Moullisha commented Dec 13, 2023

documentNamespace is a required field in v2.3.0 as per documentation but has not been mentioned in the required array in schema

image

@goneall
Copy link
Member

goneall commented Dec 13, 2023

It looks like it is included in the required array here:

"required" : [ "SPDXID", "creationInfo", "dataLicense", "name", "spdxVersion", "documentNamespace" ],

@Moullisha
Copy link
Author

Yes, it is mentioned as a required field in development/v2.3.1 but not in development/v2.3 which created confusion. Do you suggest we follow the 2.3.1 branch?

@goneall
Copy link
Member

goneall commented Dec 14, 2023

Yes, it is mentioned as a required field in development/v2.3.1 but not in development/v2.3 which created confusion.

Good point. This must have been an issue identified in 2.3.0 and fixed in the development branch.

Do you suggest we follow the 2.3.1 branch?

2.3.1 is not yet released, so there is some risk of picking up a change that may be amended later. That being said, we are only fixing critical issues in 2.3 at the moment, so you could follow the 2.3.1 branch if you want the most up to date fixes.

If the tech workgroup had more bandwidth, we'd probably do a patch release of 2.3.1, but we're all working hard to get the 3.0 release out.

@goneall goneall added this to the 2.3.1 milestone Aug 11, 2024
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

2 participants