permission-common: add comment explaining separation of type property on PermissionBase

Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-03-15 10:22:21 +00:00
parent 8dc2be1daa
commit 9a80cfc768
1 changed files with 1 additions and 1 deletions
@@ -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;

 /**