Backstage
    Preparing search index...

    A backend service interface for the scaffolder that uses @backstage/backend-plugin-api#BackstageCredentials instead of tokens.

    interface ScaffolderService {
        autocomplete(
            request: {
                context: Record<string, string>;
                provider: string;
                resource: string;
                token: string;
            },
            options: ScaffolderServiceRequestOptions,
        ): Promise<{ results: { id: string; title?: string }[] }>;
        cancelTask(
            request: { taskId: string },
            options: ScaffolderServiceRequestOptions,
        ): Promise<{ status?: ScaffolderTaskStatus }>;
        dryRun(
            request: ScaffolderDryRunOptions,
            options: ScaffolderServiceRequestOptions,
        ): Promise<ScaffolderDryRunResponse>;
        getLogs(
            request: { after?: number; taskId: string },
            options: ScaffolderServiceRequestOptions,
        ): Promise<LogEvent[]>;
        getTask(
            request: { taskId: string },
            options: ScaffolderServiceRequestOptions,
        ): Promise<ScaffolderTask>;
        getTemplateParameterSchema(
            request: { templateRef: string },
            options: ScaffolderServiceRequestOptions,
        ): Promise<TemplateParameterSchema>;
        listActions(
            request?: {},
            options?: ScaffolderServiceRequestOptions,
        ): Promise<ListActionsResponse>;
        listTasks(
            request: { createdBy?: string; limit?: number; offset?: number },
            options: ScaffolderServiceRequestOptions,
        ): Promise<{ items: ScaffolderTask[]; totalItems: number }>;
        listTemplatingExtensions(
            request?: {},
            options?: ScaffolderServiceRequestOptions,
        ): Promise<ListTemplatingExtensionsResponse>;
        retry(
            request: { taskId: string },
            options: ScaffolderServiceRequestOptions,
        ): Promise<{ id: string }>;
        scaffold(
            request: ScaffolderScaffoldOptions,
            options: ScaffolderServiceRequestOptions,
        ): Promise<ScaffolderScaffoldResponse>;
    }
    Index

    Methods

    • Parameters

      • request: {
            context: Record<string, string>;
            provider: string;
            resource: string;
            token: string;
        }
      • options: ScaffolderServiceRequestOptions

      Returns Promise<{ results: { id: string; title?: string }[] }>