From 783c435e461dffbe7fc08f660eddfcf7f501655c Mon Sep 17 00:00:00 2001 From: blam Date: Wed, 19 Jan 2022 18:38:10 +0100 Subject: [PATCH] api-docs: regenerate reports for scaffolder and changes Signed-off-by: blam --- plugins/scaffolder-backend/api-report.md | 6 ++++-- plugins/scaffolder/api-report.md | 12 ++++++++++-- plugins/scaffolder/src/api.ts | 2 +- 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index ee84e06ae9..ca6d6ac38e 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -43,6 +43,7 @@ export type ActionContext = { logger: Logger_2; logStream: Writable; token?: string | undefined; + secrets?: TaskSecrets; workspacePath: string; input: Input; output(name: string, value: JsonValue): void; @@ -439,8 +440,9 @@ export class TaskManager implements TaskContext { } // @public -export type TaskSecrets = { - token: string | undefined; +export type TaskSecrets = JsonObject & { + token?: string; + backstageToken?: string; }; export { TaskSpec }; diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index 8443de563e..7145df8097 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -192,7 +192,11 @@ export interface ScaffolderApi { // // (undocumented) listActions(): Promise; - scaffold(templateName: string, values: Record): Promise; + scaffold( + templateName: string, + values: Record, + secrets?: JsonObject, + ): Promise; // Warning: (ae-forgotten-export) The symbol "LogEvent" needs to be exported by the entry point index.d.ts // // (undocumented) @@ -236,7 +240,11 @@ export class ScaffolderClient implements ScaffolderApi { ): Promise; // (undocumented) listActions(): Promise; - scaffold(templateName: string, values: Record): Promise; + scaffold( + templateName: string, + values: Record, + secrets?: JsonObject, + ): Promise; // (undocumented) streamLogs(opts: { taskId: string; after?: number }): Observable; } diff --git a/plugins/scaffolder/src/api.ts b/plugins/scaffolder/src/api.ts index 767d3ac736..d93cdb4924 100644 --- a/plugins/scaffolder/src/api.ts +++ b/plugins/scaffolder/src/api.ts @@ -172,7 +172,7 @@ export class ScaffolderClient implements ScaffolderApi { body: JSON.stringify({ templateName, values: { ...values }, - secrets: secrets, + secrets, }), });