diff --git a/.changeset/modern-knives-roll.md b/.changeset/modern-knives-roll.md index 337fc62ed7..9af062838c 100644 --- a/.changeset/modern-knives-roll.md +++ b/.changeset/modern-knives-roll.md @@ -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, + }), +``` diff --git a/.changeset/sweet-candles-greet.md b/.changeset/sweet-candles-greet.md index 9fd08c65d6..8ab38ca0da 100644 --- a/.changeset/sweet-candles-greet.md +++ b/.changeset/sweet-candles-greet.md @@ -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, + }), +```