search

spdx / spdx-spec

The SPDX specification in MarkDown and HTML formats.
https://spdx.github.io/spdx-spec/
Other
274 stars 133 forks source link

SPDX documentation not in sync with schema #872

Open Moullisha opened 6 months ago

Moullisha commented 6 months ago

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 commented 6 months ago

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

https://github.com/spdx/spdx-spec/blob/8a595028b0386138c84f7188237787c374f6a6cf/schemas/spdx-schema.json#L748

Moullisha commented 6 months ago

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 commented 6 months ago

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.