From e26fd1c7abb95a86dafd4b3957478d51c70bd2df Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 25 Feb 2022 15:41:53 +0100 Subject: [PATCH] catalog-react: mark useEntityPermission as alpha Signed-off-by: Johan Haals --- .changeset/polite-poems-nail.md | 5 +++++ plugins/catalog-react/api-report.md | 2 +- plugins/catalog-react/src/hooks/useEntityPermission.ts | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .changeset/polite-poems-nail.md diff --git a/.changeset/polite-poems-nail.md b/.changeset/polite-poems-nail.md new file mode 100644 index 0000000000..c3eb97fce0 --- /dev/null +++ b/.changeset/polite-poems-nail.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-react': minor +--- + +Marked `useEntityPermission` as alpha since the underlying permission framework is under active development. diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md index f117e8cd5c..dfd5f7d02b 100644 --- a/plugins/catalog-react/api-report.md +++ b/plugins/catalog-react/api-report.md @@ -564,7 +564,7 @@ export function useEntityOwnership(): { isOwnedEntity: (entity: Entity | EntityName) => boolean; }; -// @public +// @alpha export function useEntityPermission(permission: Permission): { loading: boolean; allowed: boolean; diff --git a/plugins/catalog-react/src/hooks/useEntityPermission.ts b/plugins/catalog-react/src/hooks/useEntityPermission.ts index c1f62cfc39..092114936a 100644 --- a/plugins/catalog-react/src/hooks/useEntityPermission.ts +++ b/plugins/catalog-react/src/hooks/useEntityPermission.ts @@ -28,7 +28,7 @@ import { useEntity } from './useEntity'; * Note: this hook blocks the permission request until the entity has loaded in * context. If you have the entityRef and need concurrent requests, use the * `usePermission` hook directly. - * @public + * @alpha */ export function useEntityPermission(permission: Permission): { loading: boolean;