From ff2e77e41faf91d6b012e444402b7b52f71181e0 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Tue, 22 Jul 2025 10:32:04 +0200 Subject: [PATCH] docs: update linked XML spec Signed-off-by: Jan Kowalleck --- cyclonedx/model/__init__.py | 12 ++++----- cyclonedx/model/bom.py | 4 +-- cyclonedx/model/component.py | 6 ++--- cyclonedx/model/crypto.py | 40 +++++++++++++++--------------- cyclonedx/model/impact_analysis.py | 8 +++--- cyclonedx/model/license.py | 2 +- cyclonedx/model/lifecycle.py | 8 +++--- cyclonedx/model/release_note.py | 2 +- cyclonedx/model/tool.py | 2 +- cyclonedx/model/vulnerability.py | 12 ++++----- 10 files changed, 48 insertions(+), 48 deletions(-) diff --git a/cyclonedx/model/__init__.py b/cyclonedx/model/__init__.py index ba3a79a3..69c98d70 100644 --- a/cyclonedx/model/__init__.py +++ b/cyclonedx/model/__init__.py @@ -157,7 +157,7 @@ class Encoding(str, Enum): This is our internal representation of the encoding simple type within the CycloneDX standard. .. note:: - See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/#type_encoding + See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/xml/#type_encoding """ BASE_64 = 'base64' @@ -168,7 +168,7 @@ class AttachedText: This is our internal representation of the `attachedTextType` complex type within the CycloneDX standard. .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_attachedTextType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_attachedTextType """ DEFAULT_CONTENT_TYPE = 'text/plain' @@ -261,7 +261,7 @@ class HashAlgorithm(str, Enum): This is our internal representation of the hashAlg simple type within the CycloneDX standard. .. note:: - See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/#type_hashAlg + See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/xml/#type_hashAlg """ # see `_HashTypeRepositorySerializationHelper.__CASES` for view/case map BLAKE2B_256 = 'BLAKE2b-256' # Only supported in >= 1.2 @@ -384,7 +384,7 @@ class HashType: This is our internal representation of the hashType complex type within the CycloneDX standard. .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_hashType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_hashType """ @staticmethod @@ -541,7 +541,7 @@ class ExternalReferenceType(str, Enum): Enum object that defines the permissible 'types' for an External Reference according to the CycloneDX schema. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_externalReferenceType + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_externalReferenceType """ # see `_ExternalReferenceSerializationHelper.__CASES` for view/case map ADVERSARY_MODEL = 'adversary-model' # Only supported in >= 1.5 @@ -809,7 +809,7 @@ class ExternalReference: a CycloneDX BOM document. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_externalReference + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_externalReference """ def __init__( diff --git a/cyclonedx/model/bom.py b/cyclonedx/model/bom.py index b9bf521e..5ebb2f95 100644 --- a/cyclonedx/model/bom.py +++ b/cyclonedx/model/bom.py @@ -61,7 +61,7 @@ class BomMetaData: This is our internal representation of the metadata complex type within the CycloneDX standard. .. note:: - See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/#type_metadata + See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/xml/#type_metadata """ def __init__( @@ -405,7 +405,7 @@ def metadata(self) -> BomMetaData: Metadata object instance for this Bom. .. note:: - See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/#type_metadata + See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/xml/#type_metadata """ return self._metadata diff --git a/cyclonedx/model/component.py b/cyclonedx/model/component.py index 2b350f7d..65d2eecf 100644 --- a/cyclonedx/model/component.py +++ b/cyclonedx/model/component.py @@ -197,7 +197,7 @@ class ComponentScope(str, Enum): Enum object that defines the permissable 'scopes' for a Component according to the CycloneDX schema. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_scope + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_scope """ # see `_ComponentScopeSerializationHelper.__CASES` for view/case map REQUIRED = 'required' @@ -253,7 +253,7 @@ class ComponentType(str, Enum): Enum object that defines the permissible 'types' for a Component according to the CycloneDX schema. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_classification + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_classification """ # see `_ComponentTypeSerializationHelper.__CASES` for view/case map APPLICATION = 'application' @@ -937,7 +937,7 @@ class Component(Dependable): This is our internal representation of a Component within a Bom. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_component + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_component """ @staticmethod diff --git a/cyclonedx/model/crypto.py b/cyclonedx/model/crypto.py index d2ccc6c2..4a7d1f1a 100644 --- a/cyclonedx/model/crypto.py +++ b/cyclonedx/model/crypto.py @@ -22,7 +22,7 @@ Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ from collections.abc import Iterable @@ -48,7 +48,7 @@ class CryptoAssetType(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ ALGORITHM = 'algorithm' @@ -67,7 +67,7 @@ class CryptoPrimitive(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ AE = 'ae' @@ -98,7 +98,7 @@ class CryptoExecutionEnvironment(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ HARDWARE = 'hardware' @@ -120,7 +120,7 @@ class CryptoImplementationPlatform(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ ARMV7_A = 'armv7-a' @@ -150,7 +150,7 @@ class CryptoCertificationLevel(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ NONE = 'none' @@ -196,7 +196,7 @@ class CryptoMode(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ CBC = 'cbc' @@ -221,7 +221,7 @@ class CryptoPadding(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ PKCS5 = 'pkcs5' @@ -244,7 +244,7 @@ class CryptoFunction(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ DECAPSULATE = 'decapsulate' @@ -273,7 +273,7 @@ class AlgorithmProperties: Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ def __init__( @@ -525,7 +525,7 @@ class CertificateProperties: .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ def __init__( @@ -700,7 +700,7 @@ class RelatedCryptoMaterialType(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ ADDITIONAL_DATA = 'additional-data' @@ -735,7 +735,7 @@ class RelatedCryptoMaterialState(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ ACTIVE = 'active' @@ -757,7 +757,7 @@ class RelatedCryptoMaterialSecuredBy: .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ def __init__( @@ -828,7 +828,7 @@ class RelatedCryptoMaterialProperties: .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ def __init__( @@ -1072,7 +1072,7 @@ class ProtocolPropertiesType(str, Enum): Introduced in CycloneDX v1.6 .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ IKE = 'ike' @@ -1097,7 +1097,7 @@ class ProtocolPropertiesCipherSuite: .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ def __init__( @@ -1190,7 +1190,7 @@ class Ikev2TransformTypes: .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ def __init__( @@ -1332,7 +1332,7 @@ class ProtocolProperties: .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ def __init__( @@ -1457,7 +1457,7 @@ class CryptoProperties: .. note:: - See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType + See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType """ def __init__( diff --git a/cyclonedx/model/impact_analysis.py b/cyclonedx/model/impact_analysis.py index a289daf2..d82ed736 100644 --- a/cyclonedx/model/impact_analysis.py +++ b/cyclonedx/model/impact_analysis.py @@ -45,7 +45,7 @@ class ImpactAnalysisAffectedStatus(str, Enum): has not disclosed the status. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisAffectedStatusType + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_impactAnalysisAffectedStatusType """ AFFECTED = 'affected' @@ -59,7 +59,7 @@ class ImpactAnalysisJustification(str, Enum): Enum object that defines the rationale of why the impact analysis state was asserted. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisJustificationType + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_impactAnalysisJustificationType """ CODE_NOT_PRESENT = 'code_not_present' @@ -79,7 +79,7 @@ class ImpactAnalysisResponse(str, Enum): Enum object that defines the valid rationales as to why the impact analysis state was asserted. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisResponsesType + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_impactAnalysisResponsesType """ CAN_NOT_FIX = 'can_not_fix' @@ -95,7 +95,7 @@ class ImpactAnalysisState(str, Enum): Enum object that defines the permissible impact analysis states. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisStateType + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_impactAnalysisStateType """ RESOLVED = 'resolved' diff --git a/cyclonedx/model/license.py b/cyclonedx/model/license.py index 123de552..c7a34eb1 100644 --- a/cyclonedx/model/license.py +++ b/cyclonedx/model/license.py @@ -47,7 +47,7 @@ class LicenseAcknowledgement(str, Enum): .. note:: See the CycloneDX Schema for hashType: - https://cyclonedx.org/docs/1.6/#type_licenseAcknowledgementEnumerationType + https://cyclonedx.org/docs/1.6/xml/#type_licenseAcknowledgementEnumerationType """ CONCLUDED = 'concluded' diff --git a/cyclonedx/model/lifecycle.py b/cyclonedx/model/lifecycle.py index c64e3b37..e6aed27b 100644 --- a/cyclonedx/model/lifecycle.py +++ b/cyclonedx/model/lifecycle.py @@ -22,7 +22,7 @@ Introduced in CycloneDX v1.5 .. note:: - See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.6/#metadata_lifecycles + See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles """ from enum import Enum @@ -47,7 +47,7 @@ class LifecyclePhase(str, Enum): Enum object that defines the permissible 'phase' for a Lifecycle according to the CycloneDX schema. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_classification + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_classification """ DESIGN = 'design' PRE_BUILD = 'pre-build' @@ -64,7 +64,7 @@ class PredefinedLifecycle: Object that defines pre-defined phases in the product lifecycle. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#metadata_lifecycles + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles """ def __init__(self, phase: LifecyclePhase) -> None: @@ -103,7 +103,7 @@ class NamedLifecycle: Object that defines custom state in the product lifecycle. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#metadata_lifecycles + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles """ def __init__(self, name: str, *, description: Optional[str] = None) -> None: diff --git a/cyclonedx/model/release_note.py b/cyclonedx/model/release_note.py index 77745edf..9f1ff82c 100644 --- a/cyclonedx/model/release_note.py +++ b/cyclonedx/model/release_note.py @@ -33,7 +33,7 @@ class ReleaseNotes: This is our internal representation of a `releaseNotesType` for a Component in a BOM. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_releaseNotesType + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_releaseNotesType """ def __init__( diff --git a/cyclonedx/model/tool.py b/cyclonedx/model/tool.py index c8cfeab0..c547ab92 100644 --- a/cyclonedx/model/tool.py +++ b/cyclonedx/model/tool.py @@ -48,7 +48,7 @@ class Tool: In fact, this library will try to provide a compatibility layer if needed. .. note:: - See the CycloneDX Schema for toolType: https://cyclonedx.org/docs/1.6/#type_toolType + See the CycloneDX Schema for toolType: https://cyclonedx.org/docs/1.6/xml/#type_toolType """ def __init__( diff --git a/cyclonedx/model/vulnerability.py b/cyclonedx/model/vulnerability.py index 4ce767b3..744de15d 100644 --- a/cyclonedx/model/vulnerability.py +++ b/cyclonedx/model/vulnerability.py @@ -25,7 +25,7 @@ Since CycloneDX schema version 1.4, this has become part of the core schema. .. note:: - See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.6/#type_vulnerabilitiesType + See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilitiesType """ @@ -159,7 +159,7 @@ class BomTarget: from a `cyclonedx.parser.BaseParser` implementation. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType """ def __init__( @@ -367,7 +367,7 @@ class VulnerabilityAdvisory: Class that models the `advisoryType` complex type. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_advisoryType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_advisoryType """ def __init__( @@ -582,7 +582,7 @@ class VulnerabilityScoreSource(str, Enum): Enum object that defines the permissible source types for a Vulnerability's score. .. note:: - See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_scoreSourceType + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_scoreSourceType .. note:: No explicit carry-over from the former schema extension: @@ -708,7 +708,7 @@ class VulnerabilitySeverity(str, Enum): Class that defines the permissible severities for a Vulnerability. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_severityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_severityType """ NONE = 'none' INFO = 'info' # Only >= 1.4 @@ -975,7 +975,7 @@ class Vulnerability: extension (in XML only). .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType """ def __init__(