From d1a4831725334a64ffcc12e67e92718d9db22a8a Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 4 Feb 2025 15:39:10 +0100 Subject: [PATCH] permission-node: doc fixes Signed-off-by: Patrik Oldsberg --- .../definitions/PermissionsRegistryService.ts | 2 +- plugins/permission-node/src/types.ts | 11 ++++++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/packages/backend-plugin-api/src/services/definitions/PermissionsRegistryService.ts b/packages/backend-plugin-api/src/services/definitions/PermissionsRegistryService.ts index edd41e0cbc..7a3897a5bd 100644 --- a/packages/backend-plugin-api/src/services/definitions/PermissionsRegistryService.ts +++ b/packages/backend-plugin-api/src/services/definitions/PermissionsRegistryService.ts @@ -142,7 +142,7 @@ export interface PermissionsRegistryService { ): void; /** - * Returns a lookup function that can be used to look up rules for the provided resource by name. + * Returns the set of registered rules for this resource. * * @remarks * diff --git a/plugins/permission-node/src/types.ts b/plugins/permission-node/src/types.ts index 975a78acf0..b1585d1827 100644 --- a/plugins/permission-node/src/types.ts +++ b/plugins/permission-node/src/types.ts @@ -68,14 +68,12 @@ export type PermissionRule< }; /** - * A function that can be used to look up permission rules by name for a particular resource type. + * A set of registered rules for a particular resource type. * * @remarks * * Accessed via {@link @backstage/backend-plugin-api#PermissionsRegistryService.getPermissionRuleset}. * - * Will throw an error if a rule with the provided name does not exist. - * * @public */ export type PermissionRuleset< @@ -83,5 +81,12 @@ export type PermissionRuleset< TQuery = unknown, TResourceType extends string = string, > = { + /** + * Returns a resource permission rule by name. + * + * @remarks + * + * Will throw an error if a rule with the provided name does not exist. + */ getRuleByName(name: string): PermissionRule; };