Skip to content

Commit ba0b5c0

Browse files
authored
docs: update CDX spec links (#858)
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent ea627ec commit ba0b5c0

File tree

5 files changed

+20
-10
lines changed

5 files changed

+20
-10
lines changed

cyclonedx/model/component_evidence.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ class AnalysisTechnique(str, Enum):
7979
class Method:
8080
"""
8181
Represents a method used to extract and/or analyze evidence.
82+
83+
.. note::
84+
See the CycloneDX Schema definition:
85+
https://cyclonedx.org/docs/1.6/json/#components_items_evidence_identity_oneOf_i0_items_methods
8286
"""
8387

8488
def __init__(

cyclonedx/model/definition.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -581,6 +581,9 @@ def __repr__(self) -> str:
581581
class Definitions:
582582
"""
583583
The repository for definitions
584+
585+
.. note::
586+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_definitionsType
584587
"""
585588

586589
def __init__(

cyclonedx/model/issue.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ class IssueTypeSource:
4646
places within a CycloneDX BOM document.
4747
4848
.. note::
49-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_issueType
49+
See the CycloneDX Schema definition:
50+
https://cyclonedx.org/docs/1.6/json/#components_items_pedigree_patches_items_resolves_items_source
5051
"""
5152

5253
def __init__(

cyclonedx/model/license.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ class DisjunctiveLicense:
7070
a CycloneDX BOM document.
7171
7272
.. note::
73-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/json/#components_items_licenses
73+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_licenseType
7474
"""
7575

7676
def __init__(

cyclonedx/model/vulnerability.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ class BomTargetVersionRange:
6363
`version` and `version_range` are mutually exclusive.
6464
6565
.. note::
66-
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType
66+
See the CycloneDX schema:
67+
https://cyclonedx.org/docs/1.6/json/#tab-pane_vulnerabilities_items_affects_items_versions_items_oneOf_i0
6768
"""
6869

6970
def __init__(
@@ -159,7 +160,7 @@ class BomTarget:
159160
from a `cyclonedx.parser.BaseParser` implementation.
160161
161162
.. note::
162-
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType
163+
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/json/#vulnerabilities_items_affects
163164
"""
164165

165166
def __init__(
@@ -227,7 +228,7 @@ class VulnerabilityAnalysis:
227228
Class that models the `analysis` sub-element of the `vulnerabilityType` complex type.
228229
229230
.. note::
230-
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType
231+
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/json/#vulnerabilities_items_analysis
231232
"""
232233

233234
def __init__(
@@ -367,7 +368,7 @@ class VulnerabilityAdvisory:
367368
Class that models the `advisoryType` complex type.
368369
369370
.. note::
370-
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_advisoryType
371+
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/json/#vulnerabilities_items_advisories
371372
"""
372373

373374
def __init__(
@@ -433,7 +434,7 @@ class VulnerabilitySource:
433434
This type is used for multiple purposes in the CycloneDX schema.
434435
435436
.. note::
436-
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilitySourceType
437+
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/json/#vulnerabilities_items_source
437438
"""
438439

439440
def __init__(
@@ -502,7 +503,7 @@ class VulnerabilityReference:
502503
intelligence.
503504
504505
.. note::
505-
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType
506+
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/json/#vulnerabilities_items_references
506507
507508
.. note::
508509
Properties ``id`` and ``source`` are mandatory.
@@ -588,6 +589,7 @@ class VulnerabilityScoreSource(str, Enum):
588589
No explicit carry-over from the former schema extension:
589590
https://github.com/CycloneDX/specification/blob/master/schema/ext/vulnerability-1.0.xsd
590591
"""
592+
591593
# see `_VulnerabilityScoreSourceSerializationHelper.__CASES` for view/case map
592594
CVSS_V2 = 'CVSSv2'
593595
CVSS_V3 = 'CVSSv3'
@@ -762,7 +764,7 @@ class VulnerabilityRating:
762764
1.4 - see https://github.com/CycloneDX/specification/blob/master/schema/ext/vulnerability-1.0.xsd.
763765
764766
.. note::
765-
See `ratingType` in https://cyclonedx.org/docs/1.6/xml/#ratingType
767+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_ratingType
766768
767769
.. warning::
768770
As part of implementing support for CycloneDX schema version 1.4, the three score types defined in the schema
@@ -900,7 +902,7 @@ class VulnerabilityCredits:
900902
extension (in XML only).
901903
902904
.. note::
903-
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType
905+
See the CycloneDX schema: https://cyclonedx.org/docs/1.6/json/#vulnerabilities_items_credits
904906
"""
905907

906908
def __init__(

0 commit comments

Comments
 (0)