-
-
Notifications
You must be signed in to change notification settings - Fork 53
Closed
Description
From @jkowalleck
The
ref
/bom-ref
properties in CycloneDX are a special kind of string. They are intended to link elements together.
(in Spec 1.4 the ref/bom-ref became an own element-definition, to make this more clear.)
->refs
/bom-refs
are used, instead of the actual linked elements.
Having special data types makes it easy to tell elements apart by the reference. and linking elements without memory-leaks is easy.proposal:
have a data classBomRef
. BomRef has a propertyvalue
of typeOptional[str]
.
Component
s,Service
s have a property_bom_ref: BomRef
and have the the setter forbom_ref
removed - as it is a read-only property.property.- all usages of
ref
/bom-ref
adopt the use of new data typeBomRef
instead ofstr
The above will become critical when we look to implement #7 and doing this now will lower the risk of introducing another breaking change release at that point.