Interface SubmitComponents

interface SubmitComponents {
    components: {
        avatarUrl: string;
        componentType: string;
        description: string;
        id: string;
        lastUpdated: string;
        name: string;
        providerName?: string;
        schemaVersion: string;
        tier: string;
        updateSequenceNumber: number;
        url: string;
    }[];
    properties?: {};
    providerMetadata?: {
        product?: string;
    };
}

Properties

components properties? providerMetadata?

Properties

components

components: {
    avatarUrl: string;
    componentType: string;
    description: string;
    id: string;
    lastUpdated: string;
    name: string;
    providerName?: string;
    schemaVersion: string;
    tier: string;
    updateSequenceNumber: number;
    url: string;
}[]

Type declaration

  • avatarUrl: string

    A URL to display a logo representing this devops component, if available.

  • componentType: string

    The type of the component. Will be shown in the UI.

  • description: string

    A description of the DevOps Component in Markdown format. Will be shown in the UI.

  • id: string

    The identifier for the DevOps Component. Must be unique for a given Provider.

  • lastUpdated: string

    The last-updated timestamp to present to the user the last time the DevOps Component was updated.

    Expected format is an RFC3339 formatted string.

  • name: string

    The human-readable name for the DevOps Component. Will be shown in the UI.

  • Optional providerName?: string

    The human-readable name for the Provider that owns this DevOps Component. Will be shown in the UI.

  • schemaVersion: string

    The DevOpsComponentData schema version used for this devops component data.

    Placeholder to support potential schema changes in the future.

  • tier: string

    The tier of the component. Will be shown in the UI.

  • updateSequenceNumber: number

    An ID used to apply an ordering to updates for this DevOps Component in the case of out-of-order receipt of update requests.

    This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each DevOps Component and increment that on each update to Jira).

    Updates for a DevOps Component that are received with an updateSequenceId lower than what is currently stored will be ignored.

  • url: string

    A URL users can use to link to a summary view of this devops component, if appropriate.

    This could be any location that makes sense in the Provider system (e.g. if the summary information comes from a specific project, it might make sense to link the user to the component in that project).

Optional properties

properties?: {}

Properties assigned to incidents/components/review data that can then be used for delete / query operations.

Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.

Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.

Type declaration

    Optional providerMetadata

    providerMetadata?: {
        product?: string;
    }

    Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.

    Type declaration

    • Optional product?: string

      An optional name of the source of the incidents.

    Settings

    Member Visibility

    Theme

    On This Page

    componentspropertiesproviderMetadata