From 36985448d9e87d51d33fa30258a69a5db7171ff3 Mon Sep 17 00:00:00 2001
From: Alex Rybchenko <arybchenko@box.com>
Date: Thu, 29 Sep 2022 16:49:56 +0200
Subject: [PATCH] updated api docs

Signed-off-by: Alex Rybchenko <arybchenko@box.com>
---
 plugins/scaffolder/api-report.md | 24 +-----------------------
 plugins/scaffolder/src/routes.ts | 11 +++++++++++
 2 files changed, 12 insertions(+), 23 deletions(-)

diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md
index 193497a849..5931e127f5 100644
--- a/plugins/scaffolder/api-report.md
+++ b/plugins/scaffolder/api-report.md
@@ -44,8 +44,6 @@ export function createNextScaffolderFieldExtension<
   options: NextFieldExtensionOptions<TReturnValue, TInputProps>,
 ): Extension<NextFieldExtensionComponentProps<TReturnValue, TInputProps>>;
 
-// 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<undefined>;
 
@@ -71,8 +69,6 @@ export type CustomFieldValidator<TFieldReturnValue> = (
   },
 ) => void | Promise<void>;
 
-// 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<undefined>;
 
@@ -156,9 +152,7 @@ export interface LayoutOptions<P = any> {
 // @public
 export type LayoutTemplate<T = any> = FormProps<T>['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)
+// @public (undocumented)
 export const legacySelectedTemplateRouteRef: SubRouteRef<
   PathParams<'/templates/:templateName'>
 >;
@@ -186,8 +180,6 @@ 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<undefined>;
 
@@ -239,8 +231,6 @@ export const NextScaffolderPage: (
   props: PropsWithChildren<NextRouterProps>,
 ) => 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'>
@@ -280,8 +270,6 @@ 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<undefined, true>;
 
@@ -323,8 +311,6 @@ 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<undefined>;
 
@@ -470,8 +456,6 @@ 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<undefined>;
 
@@ -545,8 +529,6 @@ 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<PathParams<'/tasks/:taskId'>>;
 
@@ -564,8 +546,6 @@ export interface ScaffolderUseTemplateSecrets {
   setSecrets: (input: Record<string, string>) => 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'>
@@ -602,8 +582,6 @@ 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<
   {
diff --git a/plugins/scaffolder/src/routes.ts b/plugins/scaffolder/src/routes.ts
index 5e2d191443..26e25b54a2 100644
--- a/plugins/scaffolder/src/routes.ts
+++ b/plugins/scaffolder/src/routes.ts
@@ -19,17 +19,20 @@ import {
   createSubRouteRef,
 } from '@backstage/core-plugin-api';
 
+/** @public */
 export const registerComponentRouteRef = createExternalRouteRef({
   id: 'register-component',
   optional: true,
 });
 
+/** @public */
 export const viewTechDocRouteRef = createExternalRouteRef({
   id: 'view-techdoc',
   optional: true,
   params: ['namespace', 'kind', 'name'],
 });
 
+/** @public */
 export const rootRouteRef = createRouteRef({
   id: 'scaffolder',
 });
@@ -37,28 +40,33 @@ export const rootRouteRef = createRouteRef({
 /**
  * @deprecated This is the old template route, can be deleted before next major release
  */
+/** @public */
 export const legacySelectedTemplateRouteRef = createSubRouteRef({
   id: 'scaffolder/legacy/selected-template',
   parent: rootRouteRef,
   path: '/templates/:templateName',
 });
 
+/** @public */
 export const nextRouteRef = createRouteRef({
   id: 'scaffolder/next',
 });
 
+/** @public */
 export const selectedTemplateRouteRef = createSubRouteRef({
   id: 'scaffolder/selected-template',
   parent: rootRouteRef,
   path: '/templates/:namespace/:templateName',
 });
 
+/** @public */
 export const nextSelectedTemplateRouteRef = createSubRouteRef({
   id: 'scaffolder/next/selected-template',
   parent: nextRouteRef,
   path: '/templates/:namespace/:templateName',
 });
 
+/** @public */
 export const scaffolderTaskRouteRef = createSubRouteRef({
   id: 'scaffolder/task',
   parent: rootRouteRef,
@@ -71,18 +79,21 @@ export const nextScaffolderTaskRouteRef = createSubRouteRef({
   path: '/tasks/:taskId',
 });
 
+/** @public */
 export const scaffolderListTaskRouteRef = createSubRouteRef({
   id: 'scaffolder/list-tasks',
   parent: rootRouteRef,
   path: '/tasks',
 });
 
+/** @public */
 export const actionsRouteRef = createSubRouteRef({
   id: 'scaffolder/actions',
   parent: rootRouteRef,
   path: '/actions',
 });
 
+/** @public */
 export const editRouteRef = createSubRouteRef({
   id: 'scaffolder/edit',
   parent: rootRouteRef,