docs: remove invalid docsting note about auto-assigned bom-ref valu…

…es (#733)
CycloneDX · Oct 29, 2024 · 5aa5787 · 5aa5787
1 parent 543768e
commit 5aa5787
Show file tree

Hide file tree

Showing 5 changed files with 2 additions and 9 deletions.
diff --git a/cyclonedx/model/component.py b/cyclonedx/model/component.py
@@ -1185,8 +1185,6 @@ def bom_ref(self) -> BomRef:
         An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
         unique within the BOM.
 
-        If a value was not provided in the constructor, a UUIDv4 will have been assigned.
-
         Returns:
             `BomRef`
         """

diff --git a/cyclonedx/model/contact.py b/cyclonedx/model/contact.py
@@ -68,8 +68,6 @@ def bom_ref(self) -> Optional[BomRef]:
         An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
         unique within the BOM.
 
-        If a value was not provided in the constructor, a UUIDv4 will have been assigned.
-
         Returns:
             `BomRef`
         """

diff --git a/cyclonedx/model/definition.py b/cyclonedx/model/definition.py
@@ -81,7 +81,8 @@ def __repr__(self) -> str:
     def bom_ref(self) -> BomRef:
         """
         An optional identifier which can be used to reference the standard elsewhere in the BOM. Every bom-ref MUST be
-        unique within the BOM. If a value was not provided in the constructor, a UUIDv4 will have been assigned.
+        unique within the BOM.
+
         Returns:
             `BomRef`
         """

diff --git a/cyclonedx/model/service.py b/cyclonedx/model/service.py
@@ -95,8 +95,6 @@ def bom_ref(self) -> BomRef:
         An optional identifier which can be used to reference the service elsewhere in the BOM. Uniqueness is enforced
         within all elements and children of the root-level bom element.
 
-        If a value was not provided in the constructor, a UUIDv4 will have been assigned.
-
         Returns:
            `BomRef` unique identifier for this Service
         """

diff --git a/cyclonedx/model/vulnerability.py b/cyclonedx/model/vulnerability.py
@@ -989,8 +989,6 @@ def bom_ref(self) -> BomRef:
         """
         Get the unique reference for this Vulnerability in this BOM.
 
-        If a value was not provided in the constructor, a UUIDv4 will have been assigned.
-
         Returns:
            `BomRef`
         """