Relocate client

Signed-off-by: solimant <solimant@users.noreply.github.com>

plugins/scaffolder-common/src/ScaffolderClient.ts

@@ -40,11 +40,7 @@ import {
   ScaffolderStreamLogsOptions,
   ScaffolderTask,
 } from './api';
-import {
-  DefaultApiClient,
-  TaskStatus,
-  TypedResponse,
-} from '../client/src/schema/openapi';
+import { DefaultApiClient, TaskStatus, TypedResponse } from './schema/openapi';
 
 /**
  * An API to interact with the scaffolder backend.

plugins/scaffolder-common/src/api.ts

@@ -23,7 +23,7 @@ import type {
 import type {
   TaskEventType,
   TaskStatus as ScaffolderTaskStatus,
-} from '../client/src/schema/openapi';
+} from './schema/openapi';
 
 export type { ScaffolderTaskStatus, TaskEventType };
 

plugins/scaffolder-common/src/schema/openapi/generated/apis/Api.client.ts

@@ -0,0 +1,426 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { DiscoveryApi } from '../types/discovery';
+import { FetchApi } from '../types/fetch';
+import crossFetch from 'cross-fetch';
+import { pluginId } from '../pluginId';
+import * as parser from 'uri-template';
+import { Action } from '../models/Action.model';
+import { Autocomplete200Response } from '../models/Autocomplete200Response.model';
+import { AutocompleteRequest } from '../models/AutocompleteRequest.model';
+import { CancelTask200Response } from '../models/CancelTask200Response.model';
+import { DryRun200Response } from '../models/DryRun200Response.model';
+import { DryRunRequest } from '../models/DryRunRequest.model';
+import { ListTasksResponse } from '../models/ListTasksResponse.model';
+import { RetryRequest } from '../models/RetryRequest.model';
+import { Scaffold201Response } from '../models/Scaffold201Response.model';
+import { ScaffolderScaffoldOptions } from '../models/ScaffolderScaffoldOptions.model';
+import { SerializedTask } from '../models/SerializedTask.model';
+import { SerializedTaskEvent } from '../models/SerializedTaskEvent.model';
+import { TemplateParameterSchema } from '../models/TemplateParameterSchema.model';
+
+/**
+ * Wraps the Response type to convey a type on the json call.
+ *
+ * @public
+ */
+export type TypedResponse<T> = Omit<Response, 'json'> & {
+  json: () => Promise<T>;
+};
+
+/**
+ * Options you can pass into a request for additional information.
+ *
+ * @public
+ */
+export interface RequestOptions {
+  token?: string;
+}
+/**
+ * @public
+ */
+export type Autocomplete = {
+  path: {
+    provider: string;
+    resource: string;
+  };
+  body: AutocompleteRequest;
+};
+/**
+ * @public
+ */
+export type CancelTask = {
+  path: {
+    taskId: string;
+  };
+};
+/**
+ * @public
+ */
+export type DryRun = {
+  body: DryRunRequest;
+};
+/**
+ * @public
+ */
+export type GetTask = {
+  path: {
+    taskId: string;
+  };
+};
+/**
+ * @public
+ */
+export type GetTemplateParameterSchema = {
+  path: {
+    namespace: string;
+    kind: string;
+    name: string;
+  };
+};
+/**
+ * @public
+ */
+export type ListActions = {};
+/**
+ * @public
+ */
+export type ListTasks = {
+  query: {
+    createdBy?: Array<string>;
+    limit?: number;
+    offset?: number;
+    order?: Array<string>;
+    status?: Array<string>;
+  };
+};
+/**
+ * @public
+ */
+export type Retry = {
+  path: {
+    taskId: string;
+  };
+  body: RetryRequest;
+};
+/**
+ * @public
+ */
+export type Scaffold = {
+  body: ScaffolderScaffoldOptions;
+};
+/**
+ * @public
+ */
+export type StreamLogsPolling = {
+  path: {
+    taskId: string;
+  };
+  query: {
+    after?: number;
+  };
+};
+
+/**
+ * @public
+ */
+export class DefaultApiClient {
+  private readonly discoveryApi: DiscoveryApi;
+  private readonly fetchApi: FetchApi;
+
+  constructor(options: {
+    discoveryApi: { getBaseUrl(pluginId: string): Promise<string> };
+    fetchApi?: { fetch: typeof fetch };
+  }) {
+    this.discoveryApi = options.discoveryApi;
+    this.fetchApi = options.fetchApi || { fetch: crossFetch };
+  }
+
+  /**
+   * Perform an autocomplete for the given provider and resource.
+   * @param provider -
+   * @param resource -
+   * @param autocompleteRequest -
+   */
+  public async autocomplete(
+    // @ts-ignore
+    request: Autocomplete,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Autocomplete200Response>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/autocomplete/{provider}/{resource}`;
+
+    const uri = parser.parse(uriTemplate).expand({
+      provider: request.path.provider,
+      resource: request.path.resource,
+    });
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'POST',
+      body: JSON.stringify(request.body),
+    });
+  }
+
+  /**
+   * Sends a signal to a task broker to cancel the running task by taskId.
+   * @param taskId -
+   */
+  public async cancelTask(
+    // @ts-ignore
+    request: CancelTask,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<CancelTask200Response>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/tasks/{taskId}/cancel`;
+
+    const uri = parser.parse(uriTemplate).expand({
+      taskId: request.path.taskId,
+    });
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'POST',
+    });
+  }
+
+  /**
+   * Perform a dry-run of a template
+   * @param dryRunRequest -
+   */
+  public async dryRun(
+    // @ts-ignore
+    request: DryRun,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<DryRun200Response>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/dry-run`;
+
+    const uri = parser.parse(uriTemplate).expand({});
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'POST',
+      body: JSON.stringify(request.body),
+    });
+  }
+
+  /**
+   * Get a task by ID.
+   * @param taskId -
+   */
+  public async getTask(
+    // @ts-ignore
+    request: GetTask,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<SerializedTask>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/tasks/{taskId}`;
+
+    const uri = parser.parse(uriTemplate).expand({
+      taskId: request.path.taskId,
+    });
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'GET',
+    });
+  }
+
+  /**
+   * Get template parameter schema.
+   * @param namespace -
+   * @param kind -
+   * @param name -
+   */
+  public async getTemplateParameterSchema(
+    // @ts-ignore
+    request: GetTemplateParameterSchema,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<TemplateParameterSchema>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/templates/{namespace}/{kind}/{name}/parameter-schema`;
+
+    const uri = parser.parse(uriTemplate).expand({
+      namespace: request.path.namespace,
+      kind: request.path.kind,
+      name: request.path.name,
+    });
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'GET',
+    });
+  }
+
+  /**
+   * Returns a list of all installed actions.
+   */
+  public async listActions(
+    // @ts-ignore
+    request: ListActions,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Array<Action>>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/actions`;
+
+    const uri = parser.parse(uriTemplate).expand({});
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'GET',
+    });
+  }
+
+  /**
+   * Returns a list of tasks, filtering by ownership and/or status if given.
+   * @param createdBy - Created by
+   * @param limit - Number of records to return in the response.
+   * @param offset - Number of records to skip in the query page.
+   * @param order - Order
+   * @param status - Status
+   */
+  public async listTasks(
+    // @ts-ignore
+    request: ListTasks,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<ListTasksResponse>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/tasks{?createdBy*,limit,offset,order*,status*}`;
+
+    const uri = parser.parse(uriTemplate).expand({
+      ...request.query,
+    });
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'GET',
+    });
+  }
+
+  /**
+   * Starts the task again from the point where it failed.
+   * @param taskId -
+   * @param retryRequest -
+   */
+  public async retry(
+    // @ts-ignore
+    request: Retry,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Scaffold201Response>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/tasks/{taskId}/retry`;
+
+    const uri = parser.parse(uriTemplate).expand({
+      taskId: request.path.taskId,
+    });
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'POST',
+      body: JSON.stringify(request.body),
+    });
+  }
+
+  /**
+   * Executes the scaffolding of a component, given a template and its parameter values.
+   * @param scaffolderScaffoldOptions -
+   */
+  public async scaffold(
+    // @ts-ignore
+    request: Scaffold,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Scaffold201Response>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/tasks`;
+
+    const uri = parser.parse(uriTemplate).expand({});
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'POST',
+      body: JSON.stringify(request.body),
+    });
+  }
+
+  /**
+   * Get events for a task by ID.
+   * @param taskId -
+   * @param after - Offset event ID to stream events after.
+   */
+  public async streamLogsPolling(
+    // @ts-ignore
+    request: StreamLogsPolling,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Array<SerializedTaskEvent>>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/v2/tasks/{taskId}/events{?after}`;
+
+    const uri = parser.parse(uriTemplate).expand({
+      taskId: request.path.taskId,
+      ...request.query,
+    });
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'GET',
+    });
+  }
+}

plugins/scaffolder-common/src/schema/openapi/generated/apis/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './Api.client';

plugins/scaffolder-common/src/schema/openapi/generated/index.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './apis';
+export * from './models';

plugins/scaffolder-common/src/schema/openapi/generated/models/Action.model.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { ActionExample } from '../models/ActionExample.model';
+import { ActionSchema } from '../models/ActionSchema.model';
+
+/**
+ * The response shape for a single action in the `listActions` call to the `scaffolder-backend`
+ * @public
+ */
+export interface Action {
+  id: string;
+  description?: string;
+  examples?: Array<ActionExample>;
+  schema?: ActionSchema;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/ActionExample.model.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * A single action example
+ * @public
+ */
+export interface ActionExample {
+  description: string;
+  example: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/ActionSchema.model.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ActionSchema {
+  /**
+   * A type representing all allowed JSON object values.
+   */
+  input?: { [key: string]: any };
+  /**
+   * A type representing all allowed JSON object values.
+   */
+  output?: { [key: string]: any };
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/Autocomplete200Response.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { Autocomplete200ResponseResultsInner } from '../models/Autocomplete200ResponseResultsInner.model';
+
+/**
+ * @public
+ */
+export interface Autocomplete200Response {
+  results: Array<Autocomplete200ResponseResultsInner>;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/Autocomplete200ResponseResultsInner.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface Autocomplete200ResponseResultsInner {
+  title?: string;
+  id: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/Autocomplete400Response.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface Autocomplete400Response {
+  message?: string;
+  name?: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/AutocompleteRequest.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface AutocompleteRequest {
+  context: { [key: string]: string };
+  token: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/CancelTask200Response.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { TaskStatus } from '../models/TaskStatus.model';
+
+/**
+ * @public
+ */
+export interface CancelTask200Response {
+  status?: TaskStatus;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRun200Response.model.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { DryRun200ResponseAllOfDirectoryContentsInner } from '../models/DryRun200ResponseAllOfDirectoryContentsInner.model';
+import { DryRun200ResponseAllOfStepsInner } from '../models/DryRun200ResponseAllOfStepsInner.model';
+import { DryRunResultLogInner } from '../models/DryRunResultLogInner.model';
+
+/**
+ * @public
+ */
+export interface DryRun200Response {
+  log: Array<DryRunResultLogInner>;
+  directoryContents: Array<DryRun200ResponseAllOfDirectoryContentsInner>;
+  /**
+   * A type representing all allowed JSON object values.
+   */
+  output: { [key: string]: any };
+  steps: Array<DryRun200ResponseAllOfStepsInner>;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRun200ResponseAllOf.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { DryRun200ResponseAllOfDirectoryContentsInner } from '../models/DryRun200ResponseAllOfDirectoryContentsInner.model';
+import { DryRun200ResponseAllOfStepsInner } from '../models/DryRun200ResponseAllOfStepsInner.model';
+
+/**
+ * @public
+ */
+export interface DryRun200ResponseAllOf {
+  steps: Array<DryRun200ResponseAllOfStepsInner>;
+  directoryContents?: Array<DryRun200ResponseAllOfDirectoryContentsInner>;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRun200ResponseAllOfDirectoryContentsInner.model.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface DryRun200ResponseAllOfDirectoryContentsInner {
+  path: string;
+  executable?: boolean;
+  base64Content: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRun200ResponseAllOfStepsInner.model.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface DryRun200ResponseAllOfStepsInner {
+  [key: string]: any;
+
+  id: string;
+  name: string;
+  action: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRunRequest.model.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { DryRunRequestDirectoryContentsInner } from '../models/DryRunRequestDirectoryContentsInner.model';
+
+/**
+ * @public
+ */
+export interface DryRunRequest {
+  template: any;
+  /**
+   * A type representing all allowed JSON object values.
+   */
+  values: { [key: string]: any };
+  secrets?: { [key: string]: string };
+  directoryContents: Array<DryRunRequestDirectoryContentsInner>;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRunRequestDirectoryContentsInner.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface DryRunRequestDirectoryContentsInner {
+  path?: string;
+  base64Content?: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRunResult.model.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { DryRunResultLogInner } from '../models/DryRunResultLogInner.model';
+import { SerializedFile } from '../models/SerializedFile.model';
+
+/**
+ * @public
+ */
+export interface DryRunResult {
+  log: Array<DryRunResultLogInner>;
+  directoryContents: Array<SerializedFile>;
+  /**
+   * A type representing all allowed JSON object values.
+   */
+  output: { [key: string]: any };
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRunResultLogInner.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { DryRunResultLogInnerBody } from '../models/DryRunResultLogInnerBody.model';
+
+/**
+ * @public
+ */
+export interface DryRunResultLogInner {
+  body: DryRunResultLogInnerBody;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRunResultLogInnerBody.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { TaskStatus } from '../models/TaskStatus.model';
+
+/**
+ * @public
+ */
+export interface DryRunResultLogInnerBody {
+  message: string;
+  status?: TaskStatus;
+  stepId?: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/DryRunResultLogInnerBodyAllOf.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { TaskStatus } from '../models/TaskStatus.model';
+
+/**
+ * @public
+ */
+export interface DryRunResultLogInnerBodyAllOf {
+  message: string;
+  status?: TaskStatus;
+  stepId?: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/ErrorError.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ErrorError {
+  name: string;
+  message: string;
+  stack?: string;
+  code?: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/ErrorRequest.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ErrorRequest {
+  method: string;
+  url: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/ErrorResponse.model.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ErrorResponse {
+  statusCode: number;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/JsonPrimitive.model.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * A type representing all allowed JSON primitive values.
+ * @public
+ */
+export type JsonPrimitive = any | boolean | number | string;

plugins/scaffolder-common/src/schema/openapi/generated/models/JsonValue.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { JsonPrimitive } from '../models/JsonPrimitive.model';
+
+/**
+ * A type representing all allowed JSON values.
+ * @public
+ */
+export type JsonValue =
+  | Array<JsonValue>
+  | JsonPrimitive
+  | { [key: string]: any };

plugins/scaffolder-common/src/schema/openapi/generated/models/ListTasksResponse.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { SerializedTask } from '../models/SerializedTask.model';
+
+/**
+ * The response shape for the `listTasks` call to the `scaffolder-backend`
+ * @public
+ */
+export interface ListTasksResponse {
+  tasks: Array<SerializedTask>;
+  totalTasks?: number;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/ModelError.model.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { ErrorError } from '../models/ErrorError.model';
+import { ErrorRequest } from '../models/ErrorRequest.model';
+import { ErrorResponse } from '../models/ErrorResponse.model';
+
+/**
+ * @public
+ */
+export interface ModelError {
+  [key: string]: any;
+
+  error: ErrorError;
+  request?: ErrorRequest;
+  response: ErrorResponse;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/RetryRequest.model.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2025 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface RetryRequest {
+  secrets?: { [key: string]: string };
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/Scaffold201Response.model.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface Scaffold201Response {
+  id: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/Scaffold400Response.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { ValidationError } from '../models/ValidationError.model';
+
+/**
+ * @public
+ */
+export interface Scaffold400Response {
+  errors: Array<ValidationError>;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/ScaffolderScaffoldOptions.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * The input options to the `scaffold` method of the `ScaffolderClient`.
+ * @public
+ */
+export interface ScaffolderScaffoldOptions {
+  templateRef: string;
+  values: { [key: string]: any };
+  secrets?: { [key: string]: string };
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/SerializedFile.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface SerializedFile {
+  path: string;
+  content: string;
+  executable?: boolean;
+  symlink?: boolean;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/SerializedTask.model.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { TaskSecrets } from '../models/TaskSecrets.model';
+import { TaskStatus } from '../models/TaskStatus.model';
+
+/**
+ * SerializedTask
+ * @public
+ */
+export interface SerializedTask {
+  id: string;
+  spec: any;
+  status: TaskStatus;
+  createdAt: string;
+  lastHeartbeatAt?: string;
+  createdBy?: string;
+  secrets?: TaskSecrets;
+  /**
+   * A type representing all allowed JSON object values.
+   */
+  state?: { [key: string]: any };
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/SerializedTaskEvent.model.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { DryRunResultLogInnerBody } from '../models/DryRunResultLogInnerBody.model';
+import { TaskEventType } from '../models/TaskEventType.model';
+
+/**
+ * SerializedTaskEvent
+ * @public
+ */
+export interface SerializedTaskEvent {
+  id: number;
+  isTaskRecoverable?: boolean;
+  taskId: string;
+  body: DryRunResultLogInnerBody;
+  type: TaskEventType;
+  createdAt: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/TaskEventType.model.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export type TaskEventType = 'cancelled' | 'completion' | 'log' | 'recovered';
+
+/**
+ * @public
+ */
+export const TaskEventType = {
+  Cancelled: 'cancelled' as TaskEventType,
+  Completion: 'completion' as TaskEventType,
+  Log: 'log' as TaskEventType,
+  Recovered: 'recovered' as TaskEventType,
+};

plugins/scaffolder-common/src/schema/openapi/generated/models/TaskSecrets.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * TaskSecrets
+ * @public
+ */
+export interface TaskSecrets {
+  backstageToken?: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/TaskSecretsAllOf.model.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface TaskSecretsAllOf {
+  backstageToken?: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/TaskStatus.model.ts

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export type TaskStatus =
+  | 'cancelled'
+  | 'completed'
+  | 'failed'
+  | 'open'
+  | 'processing'
+  | 'skipped';
+
+/**
+ * @public
+ */
+export const TaskStatus = {
+  Cancelled: 'cancelled' as TaskStatus,
+  Completed: 'completed' as TaskStatus,
+  Failed: 'failed' as TaskStatus,
+  Open: 'open' as TaskStatus,
+  Processing: 'processing' as TaskStatus,
+  Skipped: 'skipped' as TaskStatus,
+};

plugins/scaffolder-common/src/schema/openapi/generated/models/TemplateParameterSchema.model.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { TemplateParameterSchemaStepsInner } from '../models/TemplateParameterSchemaStepsInner.model';
+
+/**
+ * The shape of each entry of parameters which gets rendered as a separate step in the wizard input
+ * @public
+ */
+export interface TemplateParameterSchema {
+  [key: string]: any;
+
+  title: string;
+  description?: string;
+  steps: Array<TemplateParameterSchemaStepsInner>;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/TemplateParameterSchemaStepsInner.model.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface TemplateParameterSchemaStepsInner {
+  title: string;
+  description?: string;
+  schema: any;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/ValidationError.model.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { ValidationErrorArgument } from '../models/ValidationErrorArgument.model';
+import { ValidationErrorPathInner } from '../models/ValidationErrorPathInner.model';
+
+/**
+ * @public
+ */
+export interface ValidationError {
+  [key: string]: any;
+
+  path: Array<ValidationErrorPathInner>;
+  property: string;
+  message: string;
+  instance: any;
+  name: string;
+  argument: ValidationErrorArgument;
+  stack: string;
+}

plugins/scaffolder-common/src/schema/openapi/generated/models/ValidationErrorArgument.model.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export type ValidationErrorArgument = any | boolean | number | string;

plugins/scaffolder-common/src/schema/openapi/generated/models/ValidationErrorPathInner.model.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export type ValidationErrorPathInner = number | string;

plugins/scaffolder-common/src/schema/openapi/generated/models/index.ts

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from '../models/Action.model';
+export * from '../models/ActionExample.model';
+export * from '../models/ActionSchema.model';
+export * from '../models/Autocomplete200Response.model';
+export * from '../models/Autocomplete200ResponseResultsInner.model';
+export * from '../models/Autocomplete400Response.model';
+export * from '../models/AutocompleteRequest.model';
+export * from '../models/CancelTask200Response.model';
+export * from '../models/DryRun200Response.model';
+export * from '../models/DryRun200ResponseAllOf.model';
+export * from '../models/DryRun200ResponseAllOfDirectoryContentsInner.model';
+export * from '../models/DryRun200ResponseAllOfStepsInner.model';
+export * from '../models/DryRunRequest.model';
+export * from '../models/DryRunRequestDirectoryContentsInner.model';
+export * from '../models/DryRunResult.model';
+export * from '../models/DryRunResultLogInner.model';
+export * from '../models/DryRunResultLogInnerBody.model';
+export * from '../models/DryRunResultLogInnerBodyAllOf.model';
+export * from '../models/ErrorError.model';
+export * from '../models/ErrorRequest.model';
+export * from '../models/ErrorResponse.model';
+export * from '../models/JsonPrimitive.model';
+export * from '../models/JsonValue.model';
+export * from '../models/ListTasksResponse.model';
+export * from '../models/ModelError.model';
+export * from '../models/RetryRequest.model';
+export * from '../models/Scaffold201Response.model';
+export * from '../models/Scaffold400Response.model';
+export * from '../models/ScaffolderScaffoldOptions.model';
+export * from '../models/SerializedFile.model';
+export * from '../models/SerializedTask.model';
+export * from '../models/SerializedTaskEvent.model';
+export * from '../models/TaskEventType.model';
+export * from '../models/TaskSecrets.model';
+export * from '../models/TaskSecretsAllOf.model';
+export * from '../models/TaskStatus.model';
+export * from '../models/TemplateParameterSchema.model';
+export * from '../models/TemplateParameterSchemaStepsInner.model';
+export * from '../models/ValidationError.model';
+export * from '../models/ValidationErrorArgument.model';
+export * from '../models/ValidationErrorPathInner.model';

plugins/scaffolder-common/src/schema/openapi/generated/pluginId.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export const pluginId = 'scaffolder';

plugins/scaffolder-common/src/schema/openapi/generated/types/discovery.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * This is a copy of the DiscoveryApi, to avoid importing core-plugin-api.
+ */
+export type DiscoveryApi = {
+  getBaseUrl(pluginId: string): Promise<string>;
+};

plugins/scaffolder-common/src/schema/openapi/generated/types/fetch.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * This is a copy of FetchApi, to avoid importing core-plugin-api.
+ */
+export type FetchApi = {
+  fetch: typeof fetch;
+};

plugins/scaffolder-common/src/schema/openapi/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './generated';