From abeb6b982ea01473e15207af6c7ae1a80392b75e Mon Sep 17 00:00:00 2001 From: Christopher Diaz Date: Fri, 7 Jun 2024 12:27:24 -0400 Subject: [PATCH] add api report without warnings Signed-off-by: Christopher Diaz --- plugins/catalog-backend-module-logs/api-report.md | 2 -- plugins/catalog-backend-module-logs/src/index.ts | 5 ++--- plugins/catalog-backend-module-logs/src/module.ts | 4 +--- 3 files changed, 3 insertions(+), 8 deletions(-) diff --git a/plugins/catalog-backend-module-logs/api-report.md b/plugins/catalog-backend-module-logs/api-report.md index abad6c3095..7dd45e6119 100644 --- a/plugins/catalog-backend-module-logs/api-report.md +++ b/plugins/catalog-backend-module-logs/api-report.md @@ -5,8 +5,6 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -// Warning: (ae-missing-release-tag) "catalogModuleLogs" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) const catalogModuleLogs: () => BackendFeature; export default catalogModuleLogs; diff --git a/plugins/catalog-backend-module-logs/src/index.ts b/plugins/catalog-backend-module-logs/src/index.ts index 717b7bde9e..77a7d424eb 100644 --- a/plugins/catalog-backend-module-logs/src/index.ts +++ b/plugins/catalog-backend-module-logs/src/index.ts @@ -15,9 +15,8 @@ */ /** - * The logs backend module for the catalog plugin. - * @public + * A catalog module that logs catalog errors using the logger service. + * * @packageDocumentation */ - export { catalogModuleLogs as default } from './module'; diff --git a/plugins/catalog-backend-module-logs/src/module.ts b/plugins/catalog-backend-module-logs/src/module.ts index 84f92cfe92..54fc428cdf 100644 --- a/plugins/catalog-backend-module-logs/src/module.ts +++ b/plugins/catalog-backend-module-logs/src/module.ts @@ -14,9 +14,6 @@ * limitations under the License. */ -/** - * Logs catalog errors from events. - */ import { coreServices, createBackendModule, @@ -34,6 +31,7 @@ interface EventsParamsWithPayload extends EventParams { eventPayload: EventsPayload; } +/** @public */ export const catalogModuleLogs = createBackendModule({ pluginId: 'catalog', moduleId: 'logs',