permission-common: upgrade changeset to minor bump and describe breaking change

Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2021-12-21 10:42:11 +00:00
parent 1e49c23eb7
commit 482e4a4acd
1 changed files with 12 additions and 2 deletions
@@ -1,5 +1,15 @@
 ---
-'@backstage/plugin-permission-common': patch
+'@backstage/plugin-permission-common': minor
 ---

-Create PermissionAuthorizer interface for PermissionClients
+- Add `PermissionAuthorizer` interface matching `PermissionClient` to allow alternative implementations like the `ServerPermissionClient` in @backstage/plugin-permission-node.
+
+Breaking Changes:
+
+- Remove "api" suffixes from constructor parameters in PermissionClient
+
+```diff
+  const { config, discovery } = options;
+-  const permissionClient = new PermissionClient({ discoveryApi: discovery, configApi: config });
+  const permissionClient = new PermissionClient({ discovery, config });
+```