diff --git a/cyclonedx/model/__init__.py b/cyclonedx/model/__init__.py index 121bde24..a0e6e58c 100644 --- a/cyclonedx/model/__init__.py +++ b/cyclonedx/model/__init__.py @@ -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' @@ -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__( @@ -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' @@ -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' @@ -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 @@ -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 @@ -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 @@ -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__( @@ -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. """ @@ -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' @@ -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``? """ @@ -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__( @@ -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__( diff --git a/cyclonedx/model/bom.py b/cyclonedx/model/bom.py index 7b657604..9539cff2 100644 --- a/cyclonedx/model/bom.py +++ b/cyclonedx/model/bom.py @@ -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__( @@ -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 diff --git a/cyclonedx/model/component.py b/cyclonedx/model/component.py index f553d5c0..4101ba43 100644 --- a/cyclonedx/model/component.py +++ b/cyclonedx/model/component.py @@ -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__( @@ -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__( @@ -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' @@ -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' @@ -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__( @@ -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' @@ -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__( @@ -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__( @@ -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__( @@ -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 diff --git a/cyclonedx/model/contact.py b/cyclonedx/model/contact.py index d9367e95..64f53422 100644 --- a/cyclonedx/model/contact.py +++ b/cyclonedx/model/contact.py @@ -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__( @@ -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__( diff --git a/cyclonedx/model/dependency.py b/cyclonedx/model/dependency.py index 4cdfe17e..8ed65158 100644 --- a/cyclonedx/model/dependency.py +++ b/cyclonedx/model/dependency.py @@ -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: diff --git a/cyclonedx/model/impact_analysis.py b/cyclonedx/model/impact_analysis.py index af1f5766..6722efaf 100644 --- a/cyclonedx/model/impact_analysis.py +++ b/cyclonedx/model/impact_analysis.py @@ -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 """ @@ -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' @@ -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' @@ -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' @@ -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' diff --git a/cyclonedx/model/issue.py b/cyclonedx/model/issue.py index 56bb6b76..14b35581 100644 --- a/cyclonedx/model/issue.py +++ b/cyclonedx/model/issue.py @@ -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' @@ -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__( @@ -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__( diff --git a/cyclonedx/model/license.py b/cyclonedx/model/license.py index fa4f2d33..57e7a407 100644 --- a/cyclonedx/model/license.py +++ b/cyclonedx/model/license.py @@ -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__( @@ -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` @@ -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__( diff --git a/cyclonedx/model/lifecycle.py b/cyclonedx/model/lifecycle.py index 24082f5d..7975e339 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.5/#metadata_lifecycles + See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.6/#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.3/#type_classification + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#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.5/#metadata_lifecycles + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#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.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: diff --git a/cyclonedx/model/release_note.py b/cyclonedx/model/release_note.py index a605350e..c6591735 100644 --- a/cyclonedx/model/release_note.py +++ b/cyclonedx/model/release_note.py @@ -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__( diff --git a/cyclonedx/model/service.py b/cyclonedx/model/service.py index 9e6af564..a630095d 100644 --- a/cyclonedx/model/service.py +++ b/cyclonedx/model/service.py @@ -20,7 +20,7 @@ This set of classes represents the data that is possible about known Services. .. note:: - See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.4/xml/#type_servicesType + See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.6/xml/#type_servicesType """ @@ -48,7 +48,7 @@ class Service(Dependable): Class that models the `service` complex type in the CycloneDX schema. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/xml/#type_service + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_service """ def __init__( diff --git a/cyclonedx/model/tool.py b/cyclonedx/model/tool.py index 4b056519..ff923bea 100644 --- a/cyclonedx/model/tool.py +++ b/cyclonedx/model/tool.py @@ -47,7 +47,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.3/#type_toolType + See the CycloneDX Schema for toolType: https://cyclonedx.org/docs/1.6/#type_toolType """ def __init__( diff --git a/cyclonedx/model/vulnerability.py b/cyclonedx/model/vulnerability.py index 0b7cdc1d..c22d9ef3 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.4/#type_vulnerabilitiesType + See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.6/#type_vulnerabilitiesType """ @@ -63,7 +63,7 @@ class BomTargetVersionRange: `version` and `version_range` are mutually exclusive. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType """ def __init__( @@ -158,7 +158,7 @@ class BomTarget: from a `cyclonedx.parser.BaseParser` implementation. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType """ def __init__( @@ -220,7 +220,7 @@ class VulnerabilityAnalysis: Class that models the `analysis` sub-element of the `vulnerabilityType` complex type. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType """ def __init__( @@ -344,7 +344,7 @@ class VulnerabilityAdvisory: Class that models the `advisoryType` complex type. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_advisoryType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_advisoryType """ def __init__( @@ -409,7 +409,7 @@ class VulnerabilitySource: This type is used for multiple purposes in the CycloneDX schema. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilitySourceType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilitySourceType """ def __init__( @@ -481,7 +481,7 @@ class VulnerabilityReference: intelligence. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType """ def __init__( @@ -548,7 +548,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.4/#type_scoreSourceType + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_scoreSourceType .. note:: No explicit carry-over from the former schema extension: @@ -670,7 +670,7 @@ class VulnerabilitySeverity(str, Enum): Class that defines the permissible severities for a Vulnerability. .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_severityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_severityType """ NONE = 'none' INFO = 'info' # Only >= 1.4 @@ -724,7 +724,7 @@ class VulnerabilityRating: 1.4 - see https://github.com/CycloneDX/specification/blob/master/schema/ext/vulnerability-1.0.xsd. .. note:: - See `ratingType` in https://cyclonedx.org/docs/1.4/#ratingType + See `ratingType` in https://cyclonedx.org/docs/1.6/#ratingType .. warning:: As part of implementing support for CycloneDX schema version 1.4, the three score types defined in the schema @@ -862,7 +862,7 @@ class VulnerabilityCredits: extension (in XML only). .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType """ def __init__( @@ -935,7 +935,7 @@ class Vulnerability: extension (in XML only). .. note:: - See the CycloneDX schema: https://cyclonedx.org/docs/1.4/#type_vulnerabilityType + See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType """ def __init__(