Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 13 additions & 13 deletions cyclonedx/model/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class DataFlow(str, Enum):
This is our internal representation of the dataFlowType simple type within the CycloneDX standard.

.. note::
See the CycloneDX Schema: https://cyclonedx.org/docs/1.4/xml/#type_dataFlowType
See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/xml/#type_dataFlowType
"""
INBOUND = 'inbound'
OUTBOUND = 'outbound'
Expand All @@ -82,7 +82,7 @@ class DataClassification:

.. note::
See the CycloneDX Schema for dataClassificationType:
https://cyclonedx.org/docs/1.4/xml/#type_dataClassificationType
https://cyclonedx.org/docs/1.6/xml/#type_dataClassificationType
"""

def __init__(
Expand Down Expand Up @@ -160,7 +160,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.4/#type_encoding
See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/#type_encoding
"""
BASE_64 = 'base64'

Expand All @@ -171,7 +171,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.3/#type_attachedTextType
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_attachedTextType
"""

DEFAULT_CONTENT_TYPE = 'text/plain'
Expand Down Expand Up @@ -263,7 +263,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.3/#type_hashAlg
See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/#type_hashAlg
"""
# see `_HashTypeRepositorySerializationHelper.__CASES` for view/case map
BLAKE2B_256 = 'BLAKE2b-256' # Only supported in >= 1.2
Expand Down Expand Up @@ -386,7 +386,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.3/#type_hashType
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_hashType
"""

@staticmethod
Expand Down Expand Up @@ -542,7 +542,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.3/#type_externalReferenceType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_externalReferenceType
"""
# see `_ExternalReferenceSerializationHelper.__CASES` for view/case map
ADVERSARY_MODEL = 'adversary-model' # Only supported in >= 1.5
Expand Down Expand Up @@ -810,7 +810,7 @@ class ExternalReference:
a CycloneDX BOM document.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.3/#type_externalReference
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_externalReference
"""

def __init__(
Expand Down Expand Up @@ -923,7 +923,7 @@ class Property:
a CycloneDX BOM document.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_propertyType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_propertyType

Specifies an individual property with a name and value.
"""
Expand Down Expand Up @@ -997,7 +997,7 @@ class NoteText:
a CycloneDX BOM document.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_releaseNotesType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_releaseNotesType
"""

DEFAULT_CONTENT_TYPE: str = 'text/plain'
Expand Down Expand Up @@ -1088,7 +1088,7 @@ class Note:
a CycloneDX BOM document.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_releaseNotesType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_releaseNotesType

@todo: Replace ``NoteText`` with ``AttachedText``?
"""
Expand Down Expand Up @@ -1171,7 +1171,7 @@ class IdentifiableAction:
This is our internal representation of the `identifiableActionType` complex type.

.. note::
See the CycloneDX specification: https://cyclonedx.org/docs/1.4/xml/#type_identifiableActionType
See the CycloneDX specification: https://cyclonedx.org/docs/1.6/xml/#type_identifiableActionType
"""

def __init__(
Expand Down Expand Up @@ -1261,7 +1261,7 @@ class Copyright:
This is our internal representation of the `copyrightsType` complex type.

.. note::
See the CycloneDX specification: https://cyclonedx.org/docs/1.4/xml/#type_copyrightsType
See the CycloneDX specification: https://cyclonedx.org/docs/1.6/xml/#type_copyrightsType
"""

def __init__(
Expand Down
4 changes: 2 additions & 2 deletions cyclonedx/model/bom.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,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.5/#type_metadata
See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/#type_metadata
"""

def __init__(
Expand Down Expand Up @@ -394,7 +394,7 @@ def metadata(self) -> BomMetaData:
Metadata object instance for this Bom.

.. note::
See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.3/#type_metadata
See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/#type_metadata
"""
return self._metadata

Expand Down
20 changes: 10 additions & 10 deletions cyclonedx/model/component.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ class Commit:
Our internal representation of the `commitType` complex type.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_commitType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_commitType
"""

def __init__(
Expand Down Expand Up @@ -200,7 +200,7 @@ class ComponentEvidence:
Provides the ability to document evidence collected through various forms of extraction or analysis.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_componentEvidenceType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_componentEvidenceType
"""

def __init__(
Expand Down Expand Up @@ -299,7 +299,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.3/#type_scope
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_scope
"""
# see `_ComponentScopeSerializationHelper.__CASES` for view/case map
REQUIRED = 'required'
Expand Down Expand Up @@ -355,7 +355,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.3/#type_classification
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_classification
"""
# see `_ComponentTypeSerializationHelper.__CASES` for view/case map
APPLICATION = 'application'
Expand Down Expand Up @@ -434,7 +434,7 @@ class Diff:
Our internal representation of the `diffType` complex type.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_diffType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_diffType
"""

def __init__(
Expand Down Expand Up @@ -505,7 +505,7 @@ class PatchClassification(str, Enum):
Enum object that defines the permissible `patchClassification`s.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_patchClassification
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_patchClassification
"""
BACKPORT = 'backport'
CHERRY_PICK = 'cherry-pick'
Expand All @@ -519,7 +519,7 @@ class Patch:
Our internal representation of the `patchType` complex type.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_patchType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_patchType
"""

def __init__(
Expand Down Expand Up @@ -612,7 +612,7 @@ class Pedigree:
may not be known.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_pedigreeType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_pedigreeType
"""

def __init__(
Expand Down Expand Up @@ -769,7 +769,7 @@ class Swid:
Our internal representation of the `swidType` complex type.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_swidType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_swidType
"""

def __init__(
Expand Down Expand Up @@ -1029,7 +1029,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.3/#type_component
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_component
"""

@staticmethod
Expand Down
4 changes: 2 additions & 2 deletions cyclonedx/model/contact.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ class OrganizationalContact:
within a CycloneDX BOM document.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_organizationalContact
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_organizationalContact
"""

def __init__(
Expand Down Expand Up @@ -287,7 +287,7 @@ class OrganizationalEntity:
within a CycloneDX BOM document.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_organizationalEntity
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_organizationalEntity
"""

def __init__(
Expand Down
2 changes: 1 addition & 1 deletion cyclonedx/model/dependency.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ class Dependency:
Models a Dependency within a BOM.

.. note::
See https://cyclonedx.org/docs/1.4/xml/#type_dependencyType
See https://cyclonedx.org/docs/1.6/xml/#type_dependencyType
"""

def __init__(self, ref: BomRef, dependencies: Optional[Iterable['Dependency']] = None) -> None:
Expand Down
10 changes: 5 additions & 5 deletions cyclonedx/model/impact_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
Impact Analysis is new for CycloneDX schema version 1.

.. note::
See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.4
See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.6
"""


Expand All @@ -45,7 +45,7 @@ class ImpactAnalysisAffectedStatus(str, Enum):
has not disclosed the status.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/#type_impactAnalysisAffectedStatusType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#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.4/#type_impactAnalysisJustificationType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#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.4/#type_impactAnalysisResponsesType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#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.4/#type_impactAnalysisStateType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisStateType
"""

RESOLVED = 'resolved'
Expand Down
6 changes: 3 additions & 3 deletions cyclonedx/model/issue.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class IssueClassification(str, Enum):
This is our internal representation of the enum `issueClassification`.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_issueClassification
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_issueClassification
"""
DEFECT = 'defect'
ENHANCEMENT = 'enhancement'
Expand All @@ -46,7 +46,7 @@ class IssueTypeSource:
places within a CycloneDX BOM document.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_issueType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_issueType
"""

def __init__(
Expand Down Expand Up @@ -118,7 +118,7 @@ class IssueType:
a CycloneDX BOM document.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/xml/#type_issueType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_issueType
"""

def __init__(
Expand Down
6 changes: 3 additions & 3 deletions cyclonedx/model/license.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class DisjunctiveLicense:
a CycloneDX BOM document.

.. note::
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.4/json/#components_items_licenses
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/json/#components_items_licenses
"""

def __init__(
Expand Down Expand Up @@ -94,7 +94,7 @@ def id(self) -> Optional[str]:

.. note::
See the list of expected values:
https://cyclonedx.org/docs/1.4/json/#components_items_licenses_items_license_id
https://cyclonedx.org/docs/1.6/json/#components_items_licenses_items_license_id

Returns:
`str` or `None`
Expand Down Expand Up @@ -246,7 +246,7 @@ class LicenseExpression:

.. note::
See the CycloneDX Schema definition:
https://cyclonedx.org/docs/1.4/json/#components_items_licenses_items_expression
https://cyclonedx.org/docs/1.6/json/#components_items_licenses_items_expression
"""

def __init__(
Expand Down
8 changes: 4 additions & 4 deletions cyclonedx/model/lifecycle.py
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.5/#metadata_lifecycles
See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.6/#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.3/#type_classification
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#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.5/#metadata_lifecycles
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#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.5/#metadata_lifecycles
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#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
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,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.4/#type_releaseNotesType
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_releaseNotesType
"""

def __init__(
Expand Down
Loading
Loading