From 26bd7a7a92971f9157f5a04fc537aed232414925 Mon Sep 17 00:00:00 2001 From: Christopher Diaz Date: Wed, 19 Jun 2024 12:16:26 -0400 Subject: [PATCH] try to update api docs Signed-off-by: Christopher Diaz --- plugins/catalog-backend-module-logs/api-report.md | 2 +- plugins/catalog-backend-module-logs/src/module.ts | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/plugins/catalog-backend-module-logs/api-report.md b/plugins/catalog-backend-module-logs/api-report.md index 7dd45e6119..bb08280566 100644 --- a/plugins/catalog-backend-module-logs/api-report.md +++ b/plugins/catalog-backend-module-logs/api-report.md @@ -5,7 +5,7 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -// @public (undocumented) +// @public const catalogModuleLogs: () => BackendFeature; export default catalogModuleLogs; ``` diff --git a/plugins/catalog-backend-module-logs/src/module.ts b/plugins/catalog-backend-module-logs/src/module.ts index 54fc428cdf..bdc916e958 100644 --- a/plugins/catalog-backend-module-logs/src/module.ts +++ b/plugins/catalog-backend-module-logs/src/module.ts @@ -31,7 +31,12 @@ interface EventsParamsWithPayload extends EventParams { eventPayload: EventsPayload; } -/** @public */ +/** + * A catalog module that logs catalog errors using the logger service. + * + * @packageDocumentation + * @public + */ export const catalogModuleLogs = createBackendModule({ pluginId: 'catalog', moduleId: 'logs',