From 7f4ce79b077c5e4905faf83b6cf0416a901c7e18 Mon Sep 17 00:00:00 2001
From: pamelin <pamelin@expediagroup.com>
Date: Fri, 3 Feb 2023 15:39:25 +0000
Subject: [PATCH] fix: add api-report.md for stackstorm api

Signed-off-by: pamelin <pamelin@expediagroup.com>
---
 plugins/stackstorm/api-report.md | 12 ++++--------
 plugins/stackstorm/src/index.ts  |  7 +++++++
 plugins/stackstorm/src/plugin.ts | 11 +++++++++++
 3 files changed, 22 insertions(+), 8 deletions(-)

diff --git a/plugins/stackstorm/api-report.md b/plugins/stackstorm/api-report.md
index 2a28388766..3e3d79fe27 100644
--- a/plugins/stackstorm/api-report.md
+++ b/plugins/stackstorm/api-report.md
@@ -3,17 +3,15 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+/// <reference types="react" />
+
 import { BackstagePlugin } from '@backstage/core-plugin-api';
 import { RouteRef } from '@backstage/core-plugin-api';
 
-// Warning: (ae-missing-release-tag) "StackstormPage" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export const StackstormPage: () => JSX.Element;
 
-// Warning: (ae-missing-release-tag) "stackstormPlugin" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export const stackstormPlugin: BackstagePlugin<
   {
     root: RouteRef<undefined>;
@@ -21,6 +19,4 @@ export const stackstormPlugin: BackstagePlugin<
   {},
   {}
 >;
-
-// (No @packageDocumentation comment for this package)
 ```
diff --git a/plugins/stackstorm/src/index.ts b/plugins/stackstorm/src/index.ts
index aff9e2d78a..b64ae207e4 100644
--- a/plugins/stackstorm/src/index.ts
+++ b/plugins/stackstorm/src/index.ts
@@ -13,4 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/**
+ * A Backstage plugin that integrates towards StackStorm
+ *
+ * @packageDocumentation
+ */
+
 export { stackstormPlugin, StackstormPage } from './plugin';
diff --git a/plugins/stackstorm/src/plugin.ts b/plugins/stackstorm/src/plugin.ts
index 012c78372b..74df4a0b66 100644
--- a/plugins/stackstorm/src/plugin.ts
+++ b/plugins/stackstorm/src/plugin.ts
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import {
   createApiFactory,
   createPlugin,
@@ -24,6 +25,11 @@ import { stackStormApiRef, StackStormClient } from './api';
 
 import { rootRouteRef } from './routes';
 
+/**
+ * The Backstage plugin that holds stackstorm specific components
+ *
+ * @public
+ */
 export const stackstormPlugin = createPlugin({
   id: 'stackstorm',
   apis: [
@@ -45,6 +51,11 @@ export const stackstormPlugin = createPlugin({
   },
 });
 
+/**
+ * A component to display a stackstorm home page
+ *
+ * @public
+ */
 export const StackstormPage = stackstormPlugin.provide(
   createRoutableExtension({
     name: 'StackstormPage',