catalog-backend: mark permission-related exports as alpha

Marks all strictly permission-related exports in catalog-backend as
alpha. There are permission-related properties on other exports, so
this doesn't entirely protect us from future breaking changes, but
it will certainly reduce the number.

Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>
This commit is contained in:
Mike Lewis
2022-02-28 18:31:30 +00:00
parent c89785166d
commit 0c9cf2822d
5 changed files with 21 additions and 8 deletions
+10
View File
@@ -0,0 +1,10 @@
---
'@backstage/plugin-catalog-backend': minor
---
Mark permission-related exports as alpha. This means that the exports below should now be imported from `@backstage/plugin-catalog-backend/alpha` instead of `@backstage/plugin-catalog-backend`.
- `catalogConditions`
- `createCatalogPolicyDecision`
- `permissionRules`
- `createCatalogPermissionRule`
+4 -4
View File
@@ -213,7 +213,7 @@ export class CatalogBuilder {
setRefreshIntervalSeconds(seconds: number): CatalogBuilder;
}
// @public
// @alpha
export const catalogConditions: Conditions<{
hasAnnotation: PermissionRule<
Entity,
@@ -394,12 +394,12 @@ export class CodeOwnersProcessor implements CatalogProcessor {
preProcessEntity(entity: Entity, location: LocationSpec): Promise<Entity>;
}
// @public
// @alpha
export const createCatalogPermissionRule: <TParams extends unknown[]>(
rule: PermissionRule<Entity, EntitiesSearchFilter, TParams>,
) => PermissionRule<Entity, EntitiesSearchFilter, TParams>;
// @public
// @alpha
export const createCatalogPolicyDecision: (
conditions: PermissionCriteria<PermissionCondition<unknown[]>>,
) => ConditionalPolicyDecision;
@@ -896,7 +896,7 @@ export function parseEntityYaml(
location: LocationSpec,
): Iterable<CatalogProcessorResult>;
// @public
// @alpha
export const permissionRules: {
hasAnnotation: PermissionRule<
Entity,
@@ -27,7 +27,8 @@ const conditionExports = createConditionExports({
/**
* These conditions are used when creating conditional decisions that are returned
* by authorization policies.
* @public
*
* @alpha
*/
export const catalogConditions = conditionExports.conditions;
@@ -50,7 +51,8 @@ export const catalogConditions = conditionExports.conditions;
* }
* }
* ```
* @public
*
* @alpha
*/
export const createCatalogPolicyDecision =
conditionExports.createPolicyDecision;
@@ -24,7 +24,8 @@ import { hasSpec } from './hasSpec';
/**
* These permission rules can be used to conditionally filter catalog entities
* or describe a user's access to the entities.
* @public
*
* @alpha
*/
export const permissionRules = {
hasAnnotation,
@@ -23,7 +23,7 @@ import { EntitiesSearchFilter } from '../../catalog/types';
* {@link @backstage/plugin-permission-node#PermissionRule}s for the
* catalog-backend.
*
* @public
* @alpha
*/
export const createCatalogPermissionRule = makeCreatePermissionRule<
Entity,