Skip to content

Commit

Permalink
Includes an export for KubernetesBackendClient
Browse files Browse the repository at this point in the history
Signed-off-by: Omar Babativa <obabativa@vmware.com>
  • Loading branch information
obabativavmware committed Dec 17, 2021
1 parent 3e79c4b commit 610614a
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .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.
23 changes: 23 additions & 0 deletions plugins/kubernetes/api-report.md
Expand Up @@ -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';
Expand Down Expand Up @@ -89,6 +91,27 @@ export interface KubernetesAuthProvidersApi {
// @public (undocumented)
export const kubernetesAuthProvidersApiRef: ApiRef<KubernetesAuthProvidersApi>;

// 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<ObjectsByEntityResponse>;
}

// 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)
Expand Down
1 change: 1 addition & 0 deletions plugins/kubernetes/src/api/index.ts
Expand Up @@ -16,3 +16,4 @@

export { kubernetesApiRef } from './types';
export type { KubernetesApi } from './types';
export { KubernetesBackendClient } from './KubernetesBackendClient';

0 comments on commit 610614a

Please sign in to comment.