cyclonedx.model.annotation
==========================

.. py:module:: cyclonedx.model.annotation


Classes
-------

.. autoapisummary::

   cyclonedx.model.annotation.Annotator
   cyclonedx.model.annotation.Annotation


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

.. py:class:: Annotator(*, organization: Optional[cyclonedx.model.contact.OrganizationalEntity] = None, individual: Optional[cyclonedx.model.contact.OrganizationalContact] = None, component: Optional[cyclonedx.model.component.Component] = None, service: Optional[cyclonedx.model.service.Service] = None)

   The organization, person, component, or service which created the textual content of the annotation.


   .. py:property:: organization
      :type: Optional[cyclonedx.model.contact.OrganizationalEntity]



   .. py:property:: individual
      :type: Optional[cyclonedx.model.contact.OrganizationalContact]



   .. py:property:: component
      :type: Optional[cyclonedx.model.component.Component]



   .. py:property:: service
      :type: Optional[cyclonedx.model.service.Service]



.. py:class:: Annotation(*, subjects: collections.abc.Iterable[cyclonedx.model.bom_ref.BomRef], annotator: Annotator, timestamp: datetime.datetime, text: str, bom_ref: Optional[Union[str, cyclonedx.model.bom_ref.BomRef]] = None)

   A comment, note, explanation, or similar textual content which provides additional context
   to the object(s) being annotated.


   .. py:property:: subjects
      :type: SortedSet[_AnnotationSubject]


      The object in the BOM identified by its bom-ref.



   .. py:property:: annotator
      :type: Annotator


      The organization, person, component, or service which created the textual content of the annotation.



   .. py:property:: timestamp
      :type: datetime.datetime


      The date and time (timestamp) when the annotation was created.



   .. py:property:: text
      :type: str


      The textual content of the annotation.



   .. py:property:: bom_ref
      :type: cyclonedx.model.bom_ref.BomRef


      An optional identifier which can be used to reference the annotation elsewhere in the BOM.