Type Alias Definition_Standard_Requirement

Type declaration

• OptionalbomRef?: string

  An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.

  Generated

  from field: optional string bom_ref = 1;

• descriptions: string[]

  The supplemental text that provides additional guidance or context to the requirement but is not directly part of the requirement.

  Generated

  from field: repeated string descriptions = 5;

• externalReferences: ExternalReference[]

  External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.

  Generated

  from field: repeated cyclonedx.v1_6.ExternalReference externalReferences = 9;

• Optionalidentifier?: string

  The unique identifier used in the standard to identify a specific requirement. This should match what is in the standard and should not be the requirements bom-ref.

  Generated

  from field: optional string identifier = 2;

• openCre: string[]

  The Common Requirements Enumeration (CRE) identifier(s). CRE is a structured and standardized framework for uniting security standards and guidelines. CRE links each section of a resource to a shared topic identifier (a Common Requirement). Through this shared topic link, all resources map to each other. The use of CRE promotes clear and unambiguous communication among stakeholders.

  Generated

  from field: repeated string openCre = 6;

• Optionalparent?: string

  The optional bom-ref to a parent requirement. This establishes a hierarchy of requirements. Top-level requirements must not define a parent. Only child requirements should define parents.

  Generated

  from field: optional string parent = 7;

• properties: Property[]

  Specifies optional, custom, properties

  Generated

  from field: repeated cyclonedx.v1_6.Property properties = 8;

• Optionaltext?: string

  The textual content of the requirement.

  Generated

  from field: optional string text = 4;

• Optionaltitle?: string

  The title of the requirement.

  Generated

  from field: optional string title = 3;