permissions: rename permissionIntegrations to permissionsRegistry

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2025-01-09 12:41:58 +01:00
parent dfe6e29c0c
commit cf6bd48cab
27 changed files with 92 additions and 92 deletions
@@ -30,7 +30,7 @@ type NoInfer<T> = T extends infer S ? S : never;
*
* @public
*/
export type PermissionIntegrationsServiceAddResourceTypeOptions<
export type PermissionsRegistryServiceAddResourceTypeOptions<
TResourceType extends string,
TResource,
> = {
@@ -71,7 +71,7 @@ export type PermissionIntegrationsServiceAddResourceTypeOptions<
*
* @public
*/
export interface PermissionIntegrationsService {
export interface PermissionsRegistryService {
/**
* Add permissions for this plugin to the permission system.
*/
@@ -117,13 +117,13 @@ export interface PermissionIntegrationsService {
* The `getResources` argument should load resources based on a reference
* identifier. For the catalog, this is an
* {@link @backstage/catalog-model#EntityRef}. For other plugins, this can be
* any serialized format. This is used to add a permission integrations API
* any serialized format. This is used to add a permissions registry API
* via the HTTP router service. This API will be called by the
* `permission-backend` when authorization conditions relating to this plugin
* need to be evaluated.
*/
addResourceType<const TResourceType extends string, TResource>(
options: PermissionIntegrationsServiceAddResourceTypeOptions<
options: PermissionsRegistryServiceAddResourceTypeOptions<
TResourceType,
TResource
>,
@@ -177,15 +177,15 @@ export namespace coreServices {
/**
* Permission system integration for registering resources and permissions.
*
* See {@link PermissionIntegrationsService}
* See {@link PermissionsRegistryService}
* and {@link https://backstage.io/docs/backend-system/core-services/permission-integrations | the service docs}
* for more information.
*
* @public
*/
export const permissionIntegrations = createServiceRef<
import('./PermissionIntegrationsService').PermissionIntegrationsService
>({ id: 'core.permissionIntegrations' });
export const permissionsRegistry = createServiceRef<
import('./PermissionsRegistryService').PermissionsRegistryService
>({ id: 'core.permissionsRegistry' });
/**
* Built-in service for accessing metadata about the current plugin.
@@ -51,9 +51,9 @@ export type {
PermissionsServiceRequestOptions,
} from './PermissionsService';
export type {
PermissionIntegrationsService,
PermissionIntegrationsServiceAddResourceTypeOptions,
} from './PermissionIntegrationsService';
PermissionsRegistryService,
PermissionsRegistryServiceAddResourceTypeOptions,
} from './PermissionsRegistryService';
export type { PluginMetadataService } from './PluginMetadataService';
export type { RootHttpRouterService } from './RootHttpRouterService';
export type { RootLifecycleService } from './RootLifecycleService';