Merge pull request #8769 from backstage/freben/techdocs-clients
Some more usage of the `FetchApi`
This commit is contained in:
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/core-app-api': patch
|
||||
---
|
||||
|
||||
Add an `allowUrl` callback option to `FetchMiddlewares.injectIdentityAuth`
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
'@backstage/plugin-scaffolder': minor
|
||||
---
|
||||
|
||||
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,
|
||||
}),
|
||||
```
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/test-utils': patch
|
||||
---
|
||||
|
||||
Added a `MockFetchApi`
|
||||
@@ -0,0 +1,76 @@
|
||||
---
|
||||
'@backstage/plugin-techdocs': minor
|
||||
---
|
||||
|
||||
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,
|
||||
}),
|
||||
```
|
||||
Reference in New Issue
Block a user