cyclonedx.model.annotation
Classes
The organization, person, component, or service which created the textual content of the annotation. |
|
A comment, note, explanation, or similar textual content which provides additional context |
Module Contents
- class cyclonedx.model.annotation.Annotator(*, organization: cyclonedx.model.contact.OrganizationalEntity | None = None, individual: cyclonedx.model.contact.OrganizationalContact | None = None, component: cyclonedx.model.component.Component | None = None, service: cyclonedx.model.service.Service | None = None)
The organization, person, component, or service which created the textual content of the annotation.
- property organization: cyclonedx.model.contact.OrganizationalEntity | None
- property individual: cyclonedx.model.contact.OrganizationalContact | None
- property component: cyclonedx.model.component.Component | None
- property service: cyclonedx.model.service.Service | None
- class cyclonedx.model.annotation.Annotation(*, subjects: collections.abc.Iterable[cyclonedx.model.bom_ref.BomRef], annotator: Annotator, timestamp: datetime.datetime, text: str, bom_ref: str | cyclonedx.model.bom_ref.BomRef | None = None)
A comment, note, explanation, or similar textual content which provides additional context to the object(s) being annotated.
- property subjects: SortedSet[_AnnotationSubject]
The object in the BOM identified by its bom-ref.
- property annotator: Annotator
The organization, person, component, or service which created the textual content of the annotation.
- property timestamp: datetime.datetime
The date and time (timestamp) when the annotation was created.
- property text: str
The textual content of the annotation.
- property bom_ref: cyclonedx.model.bom_ref.BomRef
An optional identifier which can be used to reference the annotation elsewhere in the BOM.