-
Notifications
You must be signed in to change notification settings - Fork 587
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
Rename top-level JSON fields #1842
Comments
If we have a config switch that allows to legacy behavior we can leverage https://github.com/anchore/go-struct-converter in the same way as done in spdx/tools-golang to support x many versions in the future (where the first would be "legacy" and "current"). |
dev note: draft branch started at https://github.com/anchore/syft/compare/rename-top-level-json-fields This should be coordinated with #1419 so we can get the last remaining breaking changes before syft 1.0 in. |
I think there is good reason to wait until syft 2.0 to make this change:
So though we could make this change for syft 1.0, we ought to wait until we implement #846 to make this transition smoother. |
Moving back to the backlog since this will land after #846 , which isn't ready yet. |
There are a couple of fields that feel like they should be renamed to better represent what they contain:
artifacts
->packages
: the original idea is that this field would be a mix of all nodes in the SBOM graph, however, it's been way more practical to break outfiles
into its own section, and there are no other types.artifactRelationships
->relationships
: given the last point, this just represents relationships between any two nodes, so we don't needartifacts
in the nameThe text was updated successfully, but these errors were encountered: