plugins: generate api reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-17 11:00:16 +02:00
parent 5429bfa69e
commit d8d7226fce
54 changed files with 5209 additions and 0 deletions
@@ -0,0 +1,103 @@
+## API Report File for "@backstage/plugin-kubernetes-backend"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Config } from '@backstage/config';
+import express from 'express';
+import { FetchResponse } from '@backstage/plugin-kubernetes-common';
+import { KubernetesFetchError } from '@backstage/plugin-kubernetes-common';
+import { KubernetesRequestBody } from '@backstage/plugin-kubernetes-common';
+import { Logger } from 'winston';
+
+// @public (undocumented)
+export interface ClusterDetails {
+    // (undocumented)
+    authProvider: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    serviceAccountToken?: string | undefined;
+    // (undocumented)
+    skipTLSVerify?: boolean;
+    // (undocumented)
+    url: string;
+}
+
+// @public (undocumented)
+export function createRouter(options: RouterOptions): Promise<express.Router>;
+
+// @public (undocumented)
+export interface CustomResource {
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    group: string;
+    // (undocumented)
+    plural: string;
+}
+
+// @public (undocumented)
+export interface FetchResponseWrapper {
+    // (undocumented)
+    errors: KubernetesFetchError[];
+    // (undocumented)
+    responses: FetchResponse[];
+}
+
+// @public (undocumented)
+export interface KubernetesClustersSupplier {
+    // (undocumented)
+    getClusters(): Promise<ClusterDetails[]>;
+}
+
+// @public (undocumented)
+export interface KubernetesFetcher {
+    // (undocumented)
+    fetchObjectsForService(params: ObjectFetchParams): Promise<FetchResponseWrapper>;
+}
+
+// @public (undocumented)
+export type KubernetesObjectTypes = 'pods' | 'services' | 'configmaps' | 'deployments' | 'replicasets' | 'horizontalpodautoscalers' | 'ingresses' | 'customresources';
+
+// @public (undocumented)
+export interface KubernetesServiceLocator {
+    // (undocumented)
+    getClustersByServiceId(serviceId: string): Promise<ClusterDetails[]>;
+}
+
+// @public (undocumented)
+export const makeRouter: (logger: Logger, kubernetesFanOutHandler: KubernetesFanOutHandler, clusterDetails: ClusterDetails[]) => express.Router;
+
+// @public (undocumented)
+export interface ObjectFetchParams {
+    // (undocumented)
+    clusterDetails: ClusterDetails;
+    // (undocumented)
+    customResources: CustomResource[];
+    // (undocumented)
+    labelSelector: string;
+    // (undocumented)
+    objectTypesToFetch: Set<KubernetesObjectTypes>;
+    // (undocumented)
+    serviceId: string;
+}
+
+// @public (undocumented)
+export interface RouterOptions {
+    // (undocumented)
+    clusterSupplier?: KubernetesClustersSupplier;
+    // (undocumented)
+    config: Config;
+    // (undocumented)
+    logger: Logger;
+}
+
+// @public (undocumented)
+export type ServiceLocatorMethod = 'multiTenant' | 'http';
+
+
+// (No @packageDocumentation comment for this package)
+
+```