From caea6122668c858fd730e6e08c2e4b98d570d832 Mon Sep 17 00:00:00 2001 From: Brian Fletcher Date: Fri, 28 Jul 2023 11:17:53 +0100 Subject: [PATCH] update the api reports Signed-off-by: Brian Fletcher --- plugins/scaffolder-node/api-report.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/plugins/scaffolder-node/api-report.md b/plugins/scaffolder-node/api-report.md index 46aba960d8..e5dec76d50 100644 --- a/plugins/scaffolder-node/api-report.md +++ b/plugins/scaffolder-node/api-report.md @@ -109,10 +109,7 @@ export type TemplateActionOptions< > = { id: string; description?: string; - examples?: { - description: string; - example: string; - }[]; + examples?: TemplateExample[]; supportsDryRun?: boolean; schema?: { input?: TInputSchema; @@ -120,4 +117,10 @@ export type TemplateActionOptions< }; handler: (ctx: ActionContext) => Promise; }; + +// @public (undocumented) +export type TemplateExample = { + description: string; + example: string; +}; ```