expand on the changesets

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-01-11 16:29:48 +01:00
parent fb565073ec
commit 3aa2ae1f91
2 changed files with 117 additions and 2 deletions
@@ -2,4 +2,48 @@
 '@backstage/plugin-scaffolder': minor
 ---

-Make `ScaffolderClient` use the `FetchApi`.
+Make `ScaffolderClient` use the `FetchApi`. You now need to pass in an instance
+of that API when constructing the client, if you create a custom instance in
+your app.
+
+If you are replacing the factory:
+
+```diff
+import { fetchApiRef } from '@backstage/core-plugin-api';
+
+ createApiFactory({
+   api: scaffolderApiRef,
+   deps: {
+     discoveryApi: discoveryApiRef,
+     scmIntegrationsApi: scmIntegrationsApiRef,
+-    identityApi: identityApiRef,
+    fetchApi: fetchApiRef,
+   },
+   factory: ({
+     discoveryApi,
+     scmIntegrationsApi,
+-    identityApi,
+    fetchApi,
+   }) =>
+     new ScaffolderClient({
+       discoveryApi,
+       scmIntegrationsApi,
+-      identityApi,
+      fetchApi,
+     }),
+ }),
+```
+
+If instantiating directly:
+
+```diff
+import { fetchApiRef } from '@backstage/core-plugin-api';
+
+const fetchApi = useApi(fetchApiRef);
+ const client = new ScaffolderClient({
+   discoveryApi,
+   scmIntegrationsApi,
+-  identityApi,
+  fetchApi,
+ }),
+```
@@ -2,4 +2,75 @@
 '@backstage/plugin-techdocs': minor
 ---

-Make `TechDocsClient` and `TechDocsStorageClient` use the `FetchApi`.
+Make `TechDocsClient` and `TechDocsStorageClient` use the `FetchApi`. You now
+need to pass in an instance of that API when constructing the client, if you
+create a custom instance in your app.
+
+If you are replacing the factory:
+
+```diff
+import { fetchApiRef } from '@backstage/core-plugin-api';
+
+ createApiFactory({
+   api: techdocsStorageApiRef,
+   deps: {
+     configApi: configApiRef,
+     discoveryApi: discoveryApiRef,
+     identityApi: identityApiRef,
+    fetchApi: fetchApiRef,
+   },
+   factory: ({
+     configApi,
+     discoveryApi,
+     identityApi,
+    fetchApi,
+   }) =>
+     new TechDocsStorageClient({
+       configApi,
+       discoveryApi,
+       identityApi,
+      fetchApi,
+     }),
+ }),
+ createApiFactory({
+   api: techdocsApiRef,
+   deps: {
+     configApi: configApiRef,
+     discoveryApi: discoveryApiRef,
+-    identityApi: identityApiRef,
+    fetchApi: fetchApiRef,
+   },
+   factory: ({
+     configApi,
+     discoveryApi,
+-    identityApi,
+    fetchApi,
+   }) =>
+     new TechDocsClient({
+       configApi,
+       discoveryApi,
+-      identityApi,
+      fetchApi,
+     }),
+ }),
+```
+
+If instantiating directly:
+
+```diff
+import { fetchApiRef } from '@backstage/core-plugin-api';
+
+const fetchApi = useApi(fetchApiRef);
+ const storageClient = new TechDocsStorageClient({
+   configApi,
+   discoveryApi,
+   identityApi,
+  fetchApi,
+ });
+ const techdocsClient = new TechDocsClient({
+   configApi,
+   discoveryApi,
+-  identityApi,
+  fetchApi,
+ }),
+```