Interface Metadata

Application definition

interface Metadata {
    description?: string;
    instanceId: string;
    links?: { about?: string; related?: string; self?: string };
    name: string;
    namespace?: `x-${string}`;
    release: string;
    serviceGroupId?: string;
    serviceId?: string;
    tags?: string[];
    version: string;
}

Hierarchy (View Summary)

Properties

description? instanceId links? name namespace? release serviceGroupId? serviceId? tags? version

Properties

Optionaldescription

description?: string

Service description

Example

`My own service description`

instanceId

instanceId: string

Service instance unique identification within the scope of the service identification

Example

`085f47e9-7fad-4da1-b5e5-31fc6eed9f94`

Optionallinks

links?: { about?: string; related?: string; self?: string }

Service related links

Type declaration

  • Optionalabout?: string

    About link for the service

    Example

    `https://www.mytra.es/about`
  • Optionalrelated?: string

    Related link for the service

    Example

    `https://www.mytra.es`
  • Optionalself?: string

    Link to the own service or health endpoint

    Example

    `http://localhost:3000/v1/health`

name

name: string

Service name

Example

`myOwnService`

Optionalnamespace

namespace?: `x-${string}`

Service namespace, used to identify declare which namespace the service belongs to. It must start with x- as it is a custom namespace and will be used for custom headers, openc2 commands, etc.

Example

`x-mytra`

release

release: string

Service release. Its recommended to use semantic versioning.

Example

`1.0.0`

OptionalserviceGroupId

serviceGroupId?: string

Service group unique identification

Example

`firehose`, `driver`

OptionalserviceId

serviceId?: string

Service unique identification

Example

`uplink-firehose`, `mqtt-driver`

Optionaltags

tags?: string[]

List of string values that can be used to add service-level labels.

Example

`["primary", "test"]`

version

version: string

Service version

Example

`1`

Settings

Member Visibility

On This Page

Properties