From 610614a06d06f389f1be8de5a51c6b297bb0e902 Mon Sep 17 00:00:00 2001 From: Omar Babativa Date: Fri, 17 Dec 2021 09:51:01 -0500 Subject: [PATCH] Includes an export for KubernetesBackendClient Signed-off-by: Omar Babativa --- .changeset/expor-k8s-backend-client.md | 5 +++++ plugins/kubernetes/api-report.md | 23 +++++++++++++++++++++++ plugins/kubernetes/src/api/index.ts | 1 + 3 files changed, 29 insertions(+) create mode 100644 .changeset/expor-k8s-backend-client.md diff --git a/.changeset/expor-k8s-backend-client.md b/.changeset/expor-k8s-backend-client.md new file mode 100644 index 0000000000..b4b7bd9973 --- /dev/null +++ b/.changeset/expor-k8s-backend-client.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-kubernetes': minor +--- + +Includes `KubernetesBackendClient` in the export to allow developers to use it externally. diff --git a/plugins/kubernetes/api-report.md b/plugins/kubernetes/api-report.md index f7afc7af9d..33ac98fb76 100644 --- a/plugins/kubernetes/api-report.md +++ b/plugins/kubernetes/api-report.md @@ -7,7 +7,9 @@ import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; +import { DiscoveryApi } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; +import { IdentityApi } from '@backstage/core-plugin-api'; import { KubernetesRequestBody } from '@backstage/plugin-kubernetes-common'; import { OAuthApi } from '@backstage/core-plugin-api'; import { ObjectsByEntityResponse } from '@backstage/plugin-kubernetes-common'; @@ -89,6 +91,27 @@ export interface KubernetesAuthProvidersApi { // @public (undocumented) export const kubernetesAuthProvidersApiRef: ApiRef; +// Warning: (ae-missing-release-tag) "KubernetesBackendClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class KubernetesBackendClient implements KubernetesApi { + constructor(options: { + discoveryApi: DiscoveryApi; + identityApi: IdentityApi; + }); + // (undocumented) + getClusters(): Promise< + { + name: string; + authProvider: string; + }[] + >; + // (undocumented) + getObjectsByEntity( + requestBody: KubernetesRequestBody, + ): Promise; +} + // Warning: (ae-missing-release-tag) "kubernetesPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) diff --git a/plugins/kubernetes/src/api/index.ts b/plugins/kubernetes/src/api/index.ts index 33c49db099..c21a258279 100644 --- a/plugins/kubernetes/src/api/index.ts +++ b/plugins/kubernetes/src/api/index.ts @@ -16,3 +16,4 @@ export { kubernetesApiRef } from './types'; export type { KubernetesApi } from './types'; +export { KubernetesBackendClient } from './KubernetesBackendClient';