From de9fc68cf12e20e864ca504b0dc83e330adeb286 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Tue, 21 Apr 2026 17:10:29 +0200 Subject: [PATCH] Document the description prop on NotificationDescription MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 4.7 (1M context) Signed-off-by: Fredrik Adelöw --- plugins/notifications/report.api.md | 1 - .../components/NotificationsTable/NotificationDescription.tsx | 3 +++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/plugins/notifications/report.api.md b/plugins/notifications/report.api.md index 74dd1b137b..627ea51e82 100644 --- a/plugins/notifications/report.api.md +++ b/plugins/notifications/report.api.md @@ -61,7 +61,6 @@ export const NotificationDescription: { // @public export interface NotificationDescriptionProps { - // (undocumented) description: string; } diff --git a/plugins/notifications/src/components/NotificationsTable/NotificationDescription.tsx b/plugins/notifications/src/components/NotificationsTable/NotificationDescription.tsx index a88d62b9c5..c284e1e85a 100644 --- a/plugins/notifications/src/components/NotificationsTable/NotificationDescription.tsx +++ b/plugins/notifications/src/components/NotificationsTable/NotificationDescription.tsx @@ -21,6 +21,9 @@ import { createSwappableComponent } from '@backstage/frontend-plugin-api'; * @public */ export interface NotificationDescriptionProps { + /** + * The plain-text description of the notification. + */ description: string; }