api-docs: regenerate reports for scaffolder and changes

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2022-01-19 18:38:10 +01:00
parent b05d303226
commit 783c435e46
3 changed files with 15 additions and 5 deletions
+4 -2
View File
@@ -43,6 +43,7 @@ export type ActionContext<Input extends InputBase> = {
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 };
+10 -2
View File
@@ -192,7 +192,11 @@ export interface ScaffolderApi {
//
// (undocumented)
listActions(): Promise<ListActionsResponse>;
scaffold(templateName: string, values: Record<string, any>): Promise<string>;
scaffold(
templateName: string,
values: Record<string, any>,
secrets?: JsonObject,
): Promise<string>;
// 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<TemplateParameterSchema>;
// (undocumented)
listActions(): Promise<ListActionsResponse>;
scaffold(templateName: string, values: Record<string, any>): Promise<string>;
scaffold(
templateName: string,
values: Record<string, any>,
secrets?: JsonObject,
): Promise<string>;
// (undocumented)
streamLogs(opts: { taskId: string; after?: number }): Observable<LogEvent>;
}
+1 -1
View File
@@ -172,7 +172,7 @@ export class ScaffolderClient implements ScaffolderApi {
body: JSON.stringify({
templateName,
values: { ...values },
secrets: secrets,
secrets,
}),
});