From 7d8734c35cb2bfcae40388bc7dbffb38da234cf4 Mon Sep 17 00:00:00 2001 From: Alex Rybchenko Date: Wed, 28 Sep 2022 15:30:51 +0200 Subject: [PATCH] updated api report Signed-off-by: Alex Rybchenko --- plugins/scaffolder/api-report.md | 75 ++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index cf69736bd4..193497a849 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -24,10 +24,12 @@ import { JsonObject } from '@backstage/types'; import { JSONSchema7 } from 'json-schema'; import { JsonValue } from '@backstage/types'; import { Observable } from '@backstage/types'; +import { PathParams } from '@backstage/core-plugin-api'; import { PropsWithChildren } from 'react'; import { default as React_2 } from 'react'; import { RouteRef } from '@backstage/core-plugin-api'; import { ScmIntegrationRegistry } from '@backstage/integration'; +import { SubRouteRef } from '@backstage/core-plugin-api'; import { TaskSpec } from '@backstage/plugin-scaffolder-common'; import { TaskStep } from '@backstage/plugin-scaffolder-common'; import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common'; @@ -42,6 +44,11 @@ export function createNextScaffolderFieldExtension< options: NextFieldExtensionOptions, ): Extension>; +// Warning: (ae-missing-release-tag) "actionsRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const actionsRouteRef: SubRouteRef; + // @public export function createScaffolderFieldExtension< TReturnValue = unknown, @@ -64,6 +71,11 @@ export type CustomFieldValidator = ( }, ) => void | Promise; +// Warning: (ae-missing-release-tag) "editRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const editRouteRef: SubRouteRef; + // @public export const EntityNamePickerFieldExtension: FieldExtensionComponent< string, @@ -144,6 +156,13 @@ export interface LayoutOptions

{ // @public export type LayoutTemplate = FormProps['ObjectFieldTemplate']; +// Warning: (ae-missing-release-tag) "legacySelectedTemplateRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public @deprecated (undocumented) +export const legacySelectedTemplateRouteRef: SubRouteRef< + PathParams<'/templates/:templateName'> +>; + // @public export type ListActionsResponse = Array<{ id: string; @@ -167,6 +186,11 @@ export type LogEvent = { taskId: string; }; +// Warning: (ae-missing-release-tag) "nextRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const nextRouteRef: RouteRef; + // @alpha export type NextCustomFieldValidator = ( data: TFieldReturnValue, @@ -215,6 +239,13 @@ export const NextScaffolderPage: ( props: PropsWithChildren, ) => JSX.Element; +// Warning: (ae-missing-release-tag) "nextSelectedTemplateRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const nextSelectedTemplateRouteRef: SubRouteRef< + PathParams<'/templates/:namespace/:templateName'> +>; + // @public export const OwnedEntityPickerFieldExtension: FieldExtensionComponent< string, @@ -249,6 +280,11 @@ export interface OwnerPickerUiOptions { defaultNamespace?: string | false; } +// Warning: (ae-missing-release-tag) "registerComponentRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const registerComponentRouteRef: ExternalRouteRef; + // @public export const repoPickerValidation: ( value: string, @@ -287,6 +323,11 @@ export interface RepoUrlPickerUiOptions { }; } +// Warning: (ae-missing-release-tag) "rootRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const rootRouteRef: RouteRef; + // @public export type RouterProps = { components?: { @@ -302,6 +343,11 @@ export type RouterProps = { filter: (entity: Entity) => boolean; }>; defaultPreviewTemplate?: string; + headerOptions?: { + pageTitleOverride?: string; + title?: string; + subtitle?: string; + }; contextMenu?: { editor?: boolean; actions?: boolean; @@ -424,6 +470,11 @@ export interface ScaffolderGetIntegrationsListResponse { // @public export const ScaffolderLayouts: React.ComponentType; +// Warning: (ae-missing-release-tag) "scaffolderListTaskRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const scaffolderListTaskRouteRef: SubRouteRef; + // @public (undocumented) export type ScaffolderOutputLink = { title?: string; @@ -494,6 +545,11 @@ export type ScaffolderTaskOutput = { [key: string]: unknown; }; +// Warning: (ae-missing-release-tag) "scaffolderTaskRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const scaffolderTaskRouteRef: SubRouteRef>; + // @public export type ScaffolderTaskStatus = | 'open' @@ -508,6 +564,13 @@ export interface ScaffolderUseTemplateSecrets { setSecrets: (input: Record) => void; } +// Warning: (ae-missing-release-tag) "selectedTemplateRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const selectedTemplateRouteRef: SubRouteRef< + PathParams<'/templates/:namespace/:templateName'> +>; + // @public export const TaskPage: ({ loadingText }: TaskPageProps) => JSX.Element; @@ -538,4 +601,16 @@ export const TemplateTypePicker: () => JSX.Element | null; // @public export const useTemplateSecrets: () => ScaffolderUseTemplateSecrets; + +// Warning: (ae-missing-release-tag) "viewTechDocRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const viewTechDocRouteRef: ExternalRouteRef< + { + name: string; + kind: string; + namespace: string; + }, + true +>; ```