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.

Sign up for GitHub

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

Jump to bottom

Replace describes relationship with rootElement property #508

Merged
merged 2 commits into from
Nov 7, 2023
Merged

Replace describes relationship with rootElement property #508

merged 2 commits into from
Nov 7, 2023

Conversation

goneall
Copy link
Member

@goneall goneall commented Oct 3, 2023

Fixes #495

This is a proposed solution based on the discussion in the tech call on 3 October, 2023.

@goneall
Replace describes relationship with rootElement property
daab535 
Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
@goneall goneall added serialization Something about the representation of data in bytes Profile:Core labels Oct 3, 2023
@goneall goneall added this to the 3.0-rc2 milestone Oct 3, 2023
kestewart
kestewart requested changes Oct 21, 2023
View reviewed changes
Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are more use cases than SBOMs, and we're using describes relationship for more than the root element. If we're doing this for SBOM's I'm fine with adding a property to the SBOM document, but I don't want to loose the capability to handle other use cases with the describes relationship.

@goneall
Add back the describes relationship type
9427480 
Per review feedback, adding the relationship type back in with a
description that makes it clear the property should be used for
root elements.

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
@goneall
Copy link
Member Author

goneall commented Oct 21, 2023

There are more use cases than SBOMs, and we're using describes relationship for more than the root element. If we're doing this for SBOM's I'm fine with adding a property to the SBOM document, but I don't want to loose the capability to handle other use cases with the describes relationship.

@kestewart - Updated the PR to add back a describes relationship type, but documented the property should be used for root elements.

@goneall goneall marked this pull request as ready for review November 3, 2023 17:21
@goneall
Copy link
Member Author

goneall commented Nov 3, 2023

@kestewart This PR now retains the describes relationship consistent with what we discussed on the tech call 31 Oct 2023. Please review.

kestewart
kestewart approved these changes Nov 7, 2023
View reviewed changes
Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. That works for me.

@kestewart kestewart merged commit e1c2d22 into main Nov 7, 2023
1 check passed
@bact bact deleted the docdescribes branch August 28, 2024 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kestewart kestewart kestewart approved these changes

Assignees
No one assigned
Labels
Profile:Core serialization Something about the representation of data in bytes
Projects
None yet
Milestone
3.0-rc2
Development

Successfully merging this pull request may close these issues.

documentDescribes relationship overlaps with rootElement
2 participants
@goneall @kestewart