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

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


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:class:: IssueTypeSource(*, name: Optional[str] = None, url: Optional[cyclonedx.model.XsUri] = None)

   This is our internal representation ofa 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:property:: name
      :type: Optional[str]


      The name of the source. For example "National Vulnerability Database", "NVD", and "Apache".

      Returns:
          `str` if set else `None`



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


      Optional url of the issue documentation as provided by the source.

      Returns:
          `XsUri` if set else `None`



.. py:class:: IssueType(*, type: IssueClassification, id: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, source: Optional[IssueTypeSource] = None, references: Optional[collections.abc.Iterable[cyclonedx.model.XsUri]] = None)

   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:property:: type
      :type: IssueClassification


      Specifies the type of issue.

      Returns:
          `IssueClassification`



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


      The identifier of the issue assigned by the source of the issue.

      Returns:
          `str` if set else `None`



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


      The name of the issue.

      Returns:
          `str` if set else `None`



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


      A description of the issue.

      Returns:
          `str` if set else `None`



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


      The source of this issue.

      Returns:
          `IssueTypeSource` if set else `None`



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


      Any reference URLs related to this issue.

      Returns:
          Set of `XsUri`