Skip to content

Commit 5aa5787

Browse files
authoredOct 29, 2024··
docs: remove invalid docsting note about auto-assigned bom-ref values (#733)
1 parent 543768e commit 5aa5787

File tree

5 files changed

+2
-9
lines changed

5 files changed

+2
-9
lines changed
 

‎cyclonedx/model/component.py

-2
Original file line numberDiff line numberDiff line change
@@ -1185,8 +1185,6 @@ def bom_ref(self) -> BomRef:
11851185
An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
11861186
unique within the BOM.
11871187
1188-
If a value was not provided in the constructor, a UUIDv4 will have been assigned.
1189-
11901188
Returns:
11911189
`BomRef`
11921190
"""

‎cyclonedx/model/contact.py

-2
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ def bom_ref(self) -> Optional[BomRef]:
6868
An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
6969
unique within the BOM.
7070
71-
If a value was not provided in the constructor, a UUIDv4 will have been assigned.
72-
7371
Returns:
7472
`BomRef`
7573
"""

‎cyclonedx/model/definition.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ def __repr__(self) -> str:
8181
def bom_ref(self) -> BomRef:
8282
"""
8383
An optional identifier which can be used to reference the standard elsewhere in the BOM. Every bom-ref MUST be
84-
unique within the BOM. If a value was not provided in the constructor, a UUIDv4 will have been assigned.
84+
unique within the BOM.
85+
8586
Returns:
8687
`BomRef`
8788
"""

‎cyclonedx/model/service.py

-2
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,6 @@ def bom_ref(self) -> BomRef:
9595
An optional identifier which can be used to reference the service elsewhere in the BOM. Uniqueness is enforced
9696
within all elements and children of the root-level bom element.
9797
98-
If a value was not provided in the constructor, a UUIDv4 will have been assigned.
99-
10098
Returns:
10199
`BomRef` unique identifier for this Service
102100
"""

‎cyclonedx/model/vulnerability.py

-2
Original file line numberDiff line numberDiff line change
@@ -989,8 +989,6 @@ def bom_ref(self) -> BomRef:
989989
"""
990990
Get the unique reference for this Vulnerability in this BOM.
991991
992-
If a value was not provided in the constructor, a UUIDv4 will have been assigned.
993-
994992
Returns:
995993
`BomRef`
996994
"""

0 commit comments

Comments
 (0)
Please sign in to comment.