cyclonedx.model.issue
=====================

.. py:module:: cyclonedx.model.issue


Attributes
----------

.. autoapisummary::

   cyclonedx.model.issue.ISSUE_CLASSIFICATION_VERSIONS


Classes
-------

.. autoapisummary::

   cyclonedx.model.issue.IssueClassification
   cyclonedx.model.issue.IssueTypeSource
   cyclonedx.model.issue.IssueType


Module Contents
---------------

.. py:class:: IssueClassification

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   This is our internal representation of the enum `issueClassification`.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_issueClassification


   .. py:attribute:: DEFECT
      :value: 'defect'



   .. py:attribute:: ENHANCEMENT
      :value: 'enhancement'



   .. py:attribute:: SECURITY
      :value: 'security'



.. py:data:: ISSUE_CLASSIFICATION_VERSIONS
   :type:  dict[IssueClassification, set[cyclonedx.schema.SchemaVersion]]

.. py:class:: IssueTypeSource

   This is our internal representation of a source within the IssueType complex type that can be used in multiple
   places within a CycloneDX BOM document.

   .. note::
       See the CycloneDX Schema definition:
       https://cyclonedx.org/docs/1.7/json/#components_items_pedigree_patches_items_resolves_items_source


   .. py:attribute:: name
      :type:  Optional[str]


   .. py:attribute:: url
      :type:  Optional[cyclonedx.model.XsUri]


.. py:class:: IssueType

   This is our internal representation of an IssueType complex type that can be used in multiple places within
   a CycloneDX BOM document.

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


   .. py:attribute:: type
      :type:  IssueClassification


   .. py:attribute:: id
      :type:  Optional[str]


   .. py:attribute:: name
      :type:  Optional[str]


   .. py:attribute:: description
      :type:  Optional[str]


   .. py:attribute:: source
      :type:  Optional[IssueTypeSource]


   .. py:attribute:: references
      :type:  SortedSet[XsUri]