Skip to content

docs: update linked XML spec #857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 22, 2025
Merged

docs: update linked XML spec #857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions cyclonedx/model/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand All @@ -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'
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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__(
Expand Down
4 changes: 2 additions & 2 deletions cyclonedx/model/bom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__(
Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions cyclonedx/model/component.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down
40 changes: 20 additions & 20 deletions cyclonedx/model/crypto.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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'
Expand All @@ -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'
Expand Down Expand Up @@ -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'
Expand All @@ -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'
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand All @@ -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'
Expand All @@ -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'
Expand Down Expand Up @@ -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__(
Expand Down Expand Up @@ -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__(
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand All @@ -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__(
Expand Down Expand Up @@ -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__(
Expand Down Expand Up @@ -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'
Expand All @@ -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__(
Expand Down Expand Up @@ -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__(
Expand Down Expand Up @@ -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__(
Expand Down Expand Up @@ -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__(
Expand Down
8 changes: 4 additions & 4 deletions cyclonedx/model/impact_analysis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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'
Expand All @@ -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'
Expand All @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion cyclonedx/model/license.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
8 changes: 4 additions & 4 deletions cyclonedx/model/lifecycle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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'
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion cyclonedx/model/release_note.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__(
Expand Down
2 changes: 1 addition & 1 deletion cyclonedx/model/tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__(
Expand Down
Loading
Loading