From 9a80cfc76845b52ddca472ff450cc340b465f1c9 Mon Sep 17 00:00:00 2001
From: MT Lewis <mtlewis@users.noreply.github.com>
Date: Tue, 15 Mar 2022 10:22:21 +0000
Subject: [PATCH] permission-common: add comment explaining separation of type
 property on PermissionBase

Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
---
 plugins/permission-common/src/types/permission.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/plugins/permission-common/src/types/permission.ts b/plugins/permission-common/src/types/permission.ts
index be820f1821..ebfdadb48b 100644
--- a/plugins/permission-common/src/types/permission.ts
+++ b/plugins/permission-common/src/types/permission.ts
@@ -47,7 +47,7 @@ export type PermissionBase<TType extends string, TFields extends object> = {
    * depend on the type. For example, a `resourceRef` should only be provided
    * when authorizing permissions of type 'resource'.
    */
-  type: TType;
+  type: TType; // Property appears on separate object to prevent expansion of Permission types in api reports.
 } & TFields;
 
 /**