Replace deprecated documentDescribes with DESCRIBES relationships #2047
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1958
Summary
Replaces the deprecated
documentDescribesfield with DESCRIBES relationships in SPDX SBOM generation, as recommended by the SPDX 2.3 schema.Changes
documentDescribesfield from SPDX outputrelationshipsarrayImplementation
The SPDX 2.3 schema explicitly marks
documentDescribesas deprecated:This implementation follows the spec recommendation by using DESCRIBES relationships where:
spdxElementId:SPDXRef-DOCUMENT(the document ID)relationshipType:DESCRIBESrelatedSpdxElement: The root package SPDX IDBackward Compatibility
The fix maintains backward compatibility:
documentDescribescan still be parsedVerification
Ran verification script:
Output:
Testing
test_spdx_document_as_dictto expect DESCRIBES relationshipstest_spdx_document_from_datawith backward compatibility test