cyclonedx.model.release_note
============================

.. py:module:: cyclonedx.model.release_note


Classes
-------

.. autoapisummary::

   cyclonedx.model.release_note.ReleaseNotes


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

.. py: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.7/xml/#type_releaseNotesType


   .. py:attribute:: type
      :type:  str


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


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


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


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


   .. py:attribute:: timestamp
      :type:  Optional[datetime.datetime]


   .. py:attribute:: aliases
      :type:  SortedSet[str]


   .. py:attribute:: tags
      :type:  SortedSet[str]


   .. py:attribute:: resolves
      :type:  SortedSet[IssueType]


   .. py:attribute:: notes
      :type:  SortedSet[Note]


   .. py:attribute:: properties
      :type:  SortedSet[Property]