cdx-proto
    Preparing search index...

    Type Alias Citation

    Citation: Message<"cyclonedx.v1_7.Citation"> & {
        attributedTo?: string;
        bomRef?: string;
        note?: string;
        process?: string;
        target:
            | { case: "pointers"; value: Citation_Pointers }
            | { case: "expressions"; value: Citation_Expressions }
            | { case: undefined; value?: undefined };
        timestamp?: Timestamp;
    }

    Details a specific attribution of data within the BOM to a contributing entity or process.

    Type Declaration

    • OptionalattributedTo?: string

      The bom_ref of an object, such as a component, service, tool, organisational entity, or person that supplied the cited information. At least one of the "attributed_to" or "process" elements must be present.

      from field: optional string attributed_to = 5;

    • OptionalbomRef?: string

      Unique identifier for the citation.

      from field: optional string bom_ref = 1;

    • Optionalnote?: string

      A description or comment about the context or quality of the data attribution.

      from field: optional string note = 7;

    • Optionalprocess?: string

      The bom_ref to a process (such as a formula, workflow, task, or step) defined in the formulation section that executed or generated the attributed data. At least one of the "attributed_to" or "process" elements must be present.

      from field: optional string process = 6;

    • target:
          | { case: "pointers"; value: Citation_Pointers }
          | { case: "expressions"; value: Citation_Expressions }
          | { case: undefined; value?: undefined }

      Exactly one of the "pointers" or "expressions" elements must be present.

      from oneof cyclonedx.v1_7.Citation.target

    • Optionaltimestamp?: Timestamp

      Timestamp when the attribution was made or the information was supplied.

      from field: google.protobuf.Timestamp timestamp = 4;

    from message cyclonedx.v1_7.Citation