From ca6b79b6a28223babf44c0397663a5b5fbd91176 Mon Sep 17 00:00:00 2001
From: Kurt King <kurtaking@gmail.com>
Date: Sat, 3 Feb 2024 14:09:54 -0700
Subject: [PATCH] chore: update report

Signed-off-by: Kurt King <kurtaking@gmail.com>
---
 .../api-report.md                                 | 15 +++++++++++++++
 .../src/permissions.ts                            | 11 ++++++++++-
 2 files changed, 25 insertions(+), 1 deletion(-)
 create mode 100644 plugins/catalog-unprocessed-entities-common/api-report.md

diff --git a/plugins/catalog-unprocessed-entities-common/api-report.md b/plugins/catalog-unprocessed-entities-common/api-report.md
new file mode 100644
index 0000000000..6d5dc15ff5
--- /dev/null
+++ b/plugins/catalog-unprocessed-entities-common/api-report.md
@@ -0,0 +1,15 @@
+## API Report File for "@backstage/plugin-catalog-unprocessed-entities-common"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { BasicPermission } from '@backstage/plugin-permission-common';
+
+// @alpha
+export const unprocessedEntitiesDeletePermission: BasicPermission;
+
+// @alpha
+export const unprocessedEntitiesPermissions: {
+  unprocessedEntitiesDeletePermission: BasicPermission;
+};
+```
diff --git a/plugins/catalog-unprocessed-entities-common/src/permissions.ts b/plugins/catalog-unprocessed-entities-common/src/permissions.ts
index c6ac44fc0b..d34cc0d1dc 100644
--- a/plugins/catalog-unprocessed-entities-common/src/permissions.ts
+++ b/plugins/catalog-unprocessed-entities-common/src/permissions.ts
@@ -15,11 +15,20 @@
  */
 import { createPermission } from '@backstage/plugin-permission-common';
 
+/**
+ * This permission is used to designate actions that involve removing an
+ * unprocessed entity record from the refresh_state table.
+ * @public
+ */
 export const unprocessedEntitiesDeletePermission = createPermission({
-  name: 'unprocessed-entities.delete',
+  name: 'catalog.entities.unprocessed.delete',
   attributes: { action: 'delete' },
 });
 
+/**
+ * List of all unprocessed entity permissions
+ * @public
+ */
 export const unprocessedEntitiesPermissions = {
   unprocessedEntitiesDeletePermission,
 };