From 9c238ca4c6e5e6c8a70b95d6bad01f9d0c09ae32 Mon Sep 17 00:00:00 2001
From: blam <ben@blam.sh>
Date: Thu, 3 Mar 2022 10:53:27 +0100
Subject: [PATCH] chore: moving isOwnerOf to alpha and documentation the
 limitations

Signed-off-by: blam <ben@blam.sh>
---
 plugins/catalog-react/api-report.md          |  4 ++--
 plugins/catalog-react/src/utils/isOwnerOf.ts | 13 +++++++++----
 2 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md
index 75414e3d59..b482bed9a6 100644
--- a/plugins/catalog-react/api-report.md
+++ b/plugins/catalog-react/api-report.md
@@ -452,8 +452,8 @@ export function InspectEntityDialog(props: {
   onClose: () => void;
 }): JSX.Element | null;
 
-// @public
-export function isOwnerOf(owner: Entity, owned: Entity): boolean;
+// @alpha
+export function isOwnerOf(owner: Entity, entity: Entity): boolean;
 
 // @public @deprecated
 export function loadCatalogOwnerRefs(
diff --git a/plugins/catalog-react/src/utils/isOwnerOf.ts b/plugins/catalog-react/src/utils/isOwnerOf.ts
index f1ba0fa35f..2b38ace247 100644
--- a/plugins/catalog-react/src/utils/isOwnerOf.ts
+++ b/plugins/catalog-react/src/utils/isOwnerOf.ts
@@ -24,10 +24,15 @@ import {
 import { getEntityRelations } from './getEntityRelations';
 
 /**
- * Get the related entity references.
- * @public
+ * Returns true if the `owner` argument is a direct owner on the `entity` argument.
+ *
+ * @alpha
+ * @remarks
+ *
+ * Note that this ownership is not the same as using the claims in the auth-resolver, it only will take into account ownership as expressed by direct entity relations.
+ * It doesn't know anything about the additional groups that a user might belong to which the claims contain.
  */
-export function isOwnerOf(owner: Entity, owned: Entity) {
+export function isOwnerOf(owner: Entity, entity: Entity) {
   const possibleOwners = new Set(
     [
       ...getEntityRelations(owner, RELATION_MEMBER_OF, { kind: 'group' }),
@@ -35,7 +40,7 @@ export function isOwnerOf(owner: Entity, owned: Entity) {
     ].map(stringifyEntityRef),
   );
 
-  const owners = getEntityRelations(owned, RELATION_OWNED_BY).map(
+  const owners = getEntityRelations(entity, RELATION_OWNED_BY).map(
     stringifyEntityRef,
   );