diff --git a/plugins/scaffolder-react/api-report-alpha.md b/plugins/scaffolder-react/api-report-alpha.md index 615b54df84..dc698e0c51 100644 --- a/plugins/scaffolder-react/api-report-alpha.md +++ b/plugins/scaffolder-react/api-report-alpha.md @@ -64,8 +64,10 @@ export const DefaultTemplateOutputs: (props: { output?: ScaffolderTaskOutput; }) => React_2.JSX.Element | null; -// @alpha (undocumented) -export const EmbeddableWorkflow: (props: WorkflowProps) => React_2.JSX.Element; +// @alpha +export const EmbeddableWorkflow: ( + workflowProps: WorkflowProps, +) => JSX.Element | null; // @alpha export const extractSchemaFromStep: (inputStep: JsonObject) => { diff --git a/plugins/scaffolder-react/src/next/components/Workflow/Workflow.tsx b/plugins/scaffolder-react/src/next/components/Workflow/Workflow.tsx index c2ea544463..4a3758cfa9 100644 --- a/plugins/scaffolder-react/src/next/components/Workflow/Workflow.tsx +++ b/plugins/scaffolder-react/src/next/components/Workflow/Workflow.tsx @@ -126,7 +126,7 @@ export const Workflow = (workflowProps: WorkflowProps): JSX.Element | null => { /** * TODO(blam): work out what we want to do with these components in the new API. - * Should we really have EmbeddableWorkflow -> Workflow -> Stepper -> Form, or should we revisit this? + * Should we really have EmbeddableWorkflow, Workflow, Stepper and Form, or should we revisit this? * @alpha */ export const EmbeddableWorkflow = Workflow;