remove support for adding entity policies entirely
Signed-off-by: Aramis <sennyeyaramis@gmail.com>
This commit is contained in:
@@ -2,4 +2,31 @@
|
||||
'@backstage/plugin-catalog-backend': minor
|
||||
---
|
||||
|
||||
Add support for defining entity policies in the new backend.
|
||||
Adds support for supplying field validators to the new backend's catalog plugin. If you're using entity policies, you should use the new `transformLegacyPolicyToProcessor` function to install them as processors instead.
|
||||
|
||||
```ts
|
||||
import {
|
||||
catalogProcessingExtensionPoint,
|
||||
catalogModelExtensionPoint,
|
||||
} from '@backstage/plugin-catalog-node/alpha';
|
||||
import {myPolicy} from './my-policy';
|
||||
|
||||
export const catalogModulePolicyProvider = createBackendModule({
|
||||
pluginId: 'catalog',
|
||||
moduleId: 'internal-policy-provider',
|
||||
register(reg) {
|
||||
reg.registerInit({
|
||||
deps: {
|
||||
modelExtensions: catalogModelExtensionPoint,
|
||||
processingExtensions: catalogProcessingExtensionPoint,
|
||||
},
|
||||
async init({ modelExtensions, processingExtensions }) {
|
||||
modelExtensions.setFieldValidators({
|
||||
...
|
||||
});
|
||||
processingExtensions.addProcessors(transformLegacyPolicyToProcessor(myPolicy))
|
||||
},
|
||||
});
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
@@ -128,21 +128,12 @@ class CatalogPermissionExtensionPointImpl
|
||||
}
|
||||
|
||||
class CatalogModelExtensionPointImpl implements CatalogModelExtensionPoint {
|
||||
#entityPolicies = new Array<EntityPolicy>();
|
||||
#fieldValidators: Partial<Validators> = {};
|
||||
|
||||
addEntityPolicies(...policies: Array<EntityPolicy | Array<EntityPolicy>>) {
|
||||
this.#entityPolicies.push(...policies.flat());
|
||||
}
|
||||
|
||||
setFieldValidators(validators: Partial<Validators>): void {
|
||||
merge(this.#fieldValidators, validators);
|
||||
}
|
||||
|
||||
get entityPolicies() {
|
||||
return this.#entityPolicies;
|
||||
}
|
||||
|
||||
get fieldValidators() {
|
||||
return this.#fieldValidators;
|
||||
}
|
||||
@@ -219,7 +210,6 @@ export const catalogPlugin = createBackendPlugin({
|
||||
);
|
||||
builder.addLocationAnalyzers(...analysisExtensions.locationAnalyzers);
|
||||
builder.addPermissionRules(...permissionExtensions.permissionRules);
|
||||
builder.addEntityPolicy(...modelExtensions.entityPolicies);
|
||||
builder.setFieldFormatValidators(modelExtensions.fieldValidators);
|
||||
|
||||
const { processingEngine, router } = await builder.build();
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
*/
|
||||
|
||||
import { createExtensionPoint } from '@backstage/backend-plugin-api';
|
||||
import { Entity, EntityPolicy, Validators } from '@backstage/catalog-model';
|
||||
import { Entity, Validators } from '@backstage/catalog-model';
|
||||
import {
|
||||
CatalogProcessor,
|
||||
EntitiesSearchFilter,
|
||||
@@ -47,14 +47,6 @@ export interface CatalogProcessingExtensionPoint {
|
||||
|
||||
/** @alpha */
|
||||
export interface CatalogModelExtensionPoint {
|
||||
/**
|
||||
* @deprecated Use `transformLegacyPolicyToProcessor` from `@backstage/plugin-catalog-backend`
|
||||
* and `CatalogProcessingExtensionPoint.addProcessor` instead.
|
||||
*/
|
||||
addEntityPolicies(
|
||||
...policies: Array<EntityPolicy | Array<EntityPolicy>>
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Sets the validator function to use for one or more special fields of an
|
||||
* entity. This is useful if the default rules for formatting of fields are
|
||||
|
||||
Reference in New Issue
Block a user