Skip to content

Commit 0ecdaa8

Browse files
authored
docs: update linked CDX spec (#860)
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent ba0b5c0 commit 0ecdaa8

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

cyclonedx/model/definition.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ def __str__(self) -> str:
9393
class Requirement:
9494
"""
9595
A requirement comprising a standard.
96+
97+
.. note::
98+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/json/#definitions_standards_items_requirements
9699
"""
97100

98101
def __init__(
@@ -286,6 +289,9 @@ def __repr__(self) -> str:
286289
class Level:
287290
"""
288291
Level of compliance for a standard.
292+
293+
.. note::
294+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/json/#definitions_standards_items_levels
289295
"""
290296

291297
def __init__(
@@ -402,6 +408,9 @@ class Standard:
402408
"""
403409
A standard of regulations, industry or organizational-specific standards, maturity models, best practices,
404410
or any other requirements.
411+
412+
.. note::
413+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_standard
405414
"""
406415

407416
def __init__(

cyclonedx/model/lifecycle.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ class PredefinedLifecycle:
6464
Object that defines pre-defined phases in the product lifecycle.
6565
6666
.. note::
67-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles
67+
See the CycloneDX Schema definition:
68+
https://cyclonedx.org/docs/1.6/json/#tab-pane_metadata_lifecycles_items_oneOf_i0
6869
"""
6970

7071
def __init__(self, phase: LifecyclePhase) -> None:
@@ -103,7 +104,8 @@ class NamedLifecycle:
103104
Object that defines custom state in the product lifecycle.
104105
105106
.. note::
106-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles
107+
See the CycloneDX Schema definition:
108+
https://cyclonedx.org/docs/1.6/json/#tab-pane_metadata_lifecycles_items_oneOf_i1
107109
"""
108110

109111
def __init__(self, name: str, *, description: Optional[str] = None) -> None:

0 commit comments

Comments
 (0)