paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 48 Packages Projects Releases Wiki Activity

Updated changelog for plugin-catalog-backend to be more focused on createCatalogConditionalDecision

Browse Source 
Signed-off-by: Harry Hogg <hhogg@spotify.com>
This commit is contained in:
Harry Hogg
2022-10-11 11:55:40 +01:00
parent 30592654f9
commit 3f25d863b0
1 changed files with 1 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/seven-panthers-chew.md
+1 -29
View File
@@ -2,32 +2,4 @@
'@backstage/plugin-catalog-backend': minor
---
**BREAKING** Due to the changes made in the Permission framework. The catalogs permission rules and the API of `createCatalogPermissionRule` have been changed to reflect the change from individual function parameters to a single object parameter and the addition of the `paramsSchema`.
As an example for the `hasLabel` rule. The API before the change was
```ts
hasLabel.apply(entity, 'backstage.io/testLabel');
hasLabel.toQuery('backstage.io/testLabel');
```
and the API after the change now is
```ts
hasLabel.apply(entity, {
label: 'backstage.io/testLabel',
});
hasLabel.toQuery({
label: 'backstage.io/testLabel',
});
```
This applies to all of the permission rules exported by the catalog backend.
- `hasAnnotation`
- `hasLabel`
- `hasMetadata`
- `hasSpec`
- `isEntityKind`
- `isEntityOwner`
**BREAKING** The exported permission rules and the API of `createCatalogConditionalDecision` have changed to reflect the breaking changes made to the PermissionRule type.