Backstage
    Preparing search index...

    Interface TemplateEntityV1beta3

    Backstage catalog Template kind Entity. Templates are used by the Scaffolder plugin to create new entities, such as Components.

    interface TemplateEntityV1beta3 {
        apiVersion: "scaffolder.backstage.io/v1beta3";
        kind: "Template";
        metadata: EntityMeta;
        relations?: EntityRelation[];
        spec: {
            EXPERIMENTAL_formDecorators?: { id: string; input?: JsonObject }[];
            EXPERIMENTAL_recovery?: TemplateRecoveryV1beta3;
            lifecycle?: string;
            output?: { [name: string]: string };
            owner?: string;
            parameters?: TemplateParametersV1beta3 | TemplateParametersV1beta3[];
            presentation?: TemplatePresentationV1beta3;
            steps: TemplateEntityStepV1beta3[];
            type: string;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiVersion kind metadata relations? spec

    Properties

    apiVersion: "scaffolder.backstage.io/v1beta3"

    The apiVersion string of the TaskSpec.

    kind: "Template"

    The kind of the entity

    metadata: EntityMeta

    Metadata related to the entity.

    relations?: EntityRelation[]

    The relations that this entity has with other entities.

    spec: {
        EXPERIMENTAL_formDecorators?: { id: string; input?: JsonObject }[];
        EXPERIMENTAL_recovery?: TemplateRecoveryV1beta3;
        lifecycle?: string;
        output?: { [name: string]: string };
        owner?: string;
        parameters?: TemplateParametersV1beta3 | TemplateParametersV1beta3[];
        presentation?: TemplatePresentationV1beta3;
        steps: TemplateEntityStepV1beta3[];
        type: string;
    }

    The specification of the Template Entity

    Type Declaration

    • OptionalEXPERIMENTAL_formDecorators?: { id: string; input?: JsonObject }[]

      Form hooks to be run

    • OptionalEXPERIMENTAL_recovery?: TemplateRecoveryV1beta3

      Recovery strategy for the template

    • Optionallifecycle?: string

      Specifies the lifecycle phase of the TemplateEntity

    • Optionaloutput?: { [name: string]: string }

      The output is an object where template authors can pull out information from template actions and return them in a known standard way.

    • Optionalowner?: string

      The owner entityRef of the TemplateEntity

    • Optionalparameters?: TemplateParametersV1beta3 | TemplateParametersV1beta3[]

      This is a JSONSchema or an array of JSONSchema's which is used to render a form in the frontend to collect user input and validate it against that schema. This can then be used in the steps part below to template variables passed from the user into each action in the template.

    • Optionalpresentation?: TemplatePresentationV1beta3

      Template specific configuration of the presentation layer.

    • steps: TemplateEntityStepV1beta3[]

      A list of steps to be executed in sequence which are defined by the template. These steps are a list of the underlying javascript action and some optional input parameters that may or may not have been collected from the end user.

    • type: string

      The type that the Template will create. For example service, website or library.

    Settings

    Member Visibility

    On This Page

    Properties