cdx-proto
    Preparing search index...

    Type Alias Service

    Service: Message<"cyclonedx.v1_7.Service"> & {
        authenticated?: boolean;
        bomRef?: string;
        data: DataFlow[];
        description?: string;
        endpoints: string[];
        externalReferences: ExternalReference[];
        group?: string;
        licenses: LicenseChoice[];
        name: string;
        patentAssertions: PatentAssertion[];
        properties: Property[];
        provider?: OrganizationalEntity;
        releaseNotes?: ReleaseNotes;
        services: Service[];
        tags: string[];
        trustZone?: string;
        version?: string;
        xTrustBoundary?: boolean;
    }

    Type Declaration

    • Optionalauthenticated?: boolean

      A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication.

      from field: optional bool authenticated = 8;

    • OptionalbomRef?: string

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

      from field: optional string bom_ref = 1;

    • data: DataFlow[]

      Specifies information about the data including the directional flow of data and the data classification.

      from field: repeated cyclonedx.v1_7.DataFlow data = 10;

    • Optionaldescription?: string

      Specifies a description for the service.

      from field: optional string description = 6;

    • endpoints: string[]

      The endpoint URIs of the service. Multiple endpoints are allowed. Example: "https://example.com/api/v1/ticker"

      from field: repeated string endpoints = 7;

    • externalReferences: ExternalReference[]

      Provides the ability to document external references related to the service.

      from field: repeated cyclonedx.v1_7.ExternalReference external_references = 12;

    • Optionalgroup?: string

      The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.

      from field: optional string group = 3;

    • licenses: LicenseChoice[]

      A list of SPDX licenses and/or named licenses and/or SPDX License Expression.

      from field: repeated cyclonedx.v1_7.LicenseChoice licenses = 11;

    • name: string

      The name of the service. This will often be a shortened, single name of the service.

      from field: string name = 4;

    • patentAssertions: PatentAssertion[]

      A list of assertions made regarding patents associated with this component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents.

      from field: repeated cyclonedx.v1_7.PatentAssertion patent_assertions = 18;

    • properties: Property[]

      Specifies custom properties.

      from field: repeated cyclonedx.v1_7.Property properties = 14;

    • Optionalprovider?: OrganizationalEntity

      The organization that provides the service.

      from field: optional cyclonedx.v1_7.OrganizationalEntity provider = 2;

    • OptionalreleaseNotes?: ReleaseNotes

      Specifies release notes.

      from field: optional cyclonedx.v1_7.ReleaseNotes releaseNotes = 15;

    • services: Service[]

      Specifies sub-service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies, similar to system -> subsystem -> parts assembly in physical supply chains.

      from field: repeated cyclonedx.v1_7.Service services = 13;

    • tags: string[]

      Textual strings that aid in the discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes. Examples include "json-parser", "object-persistence", "text-to-image", "translation", and "object-detection".

      from field: repeated string tags = 17;

    • OptionaltrustZone?: string

      The name of the trust zone the service resides in.

      from field: optional string trustZone = 16;

    • Optionalversion?: string

      The service version.

      from field: optional string version = 5;

    • OptionalxTrustBoundary?: boolean

      A boolean value indicating if the use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed.

      from field: optional bool x_trust_boundary = 9;

    from message cyclonedx.v1_7.Service

    Settings

    Member Visibility