chore: fix up code review comments
Signed-off-by: benjdlambert <ben@blam.sh>
This commit is contained in:
@@ -24,6 +24,20 @@ import {
|
||||
KubernetesServiceLocator,
|
||||
} from '@backstage/plugin-kubernetes-node';
|
||||
|
||||
/**
|
||||
* A factory function for creating a KubernetesObjectsProvider.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export type KubernetesObjectsProviderFactory = (opts: {
|
||||
getDefault: () => Promise<KubernetesObjectsProvider>;
|
||||
clusterSupplier: KubernetesClustersSupplier;
|
||||
serviceLocator: KubernetesServiceLocator;
|
||||
customResources: CustomResource[];
|
||||
objectTypesToFetch?: ObjectToFetch[];
|
||||
authStrategy: AuthenticationStrategy;
|
||||
}) => Promise<KubernetesObjectsProvider>;
|
||||
|
||||
/**
|
||||
* The interface for {@link kubernetesObjectsProviderExtensionPoint}.
|
||||
*
|
||||
@@ -31,23 +45,7 @@ import {
|
||||
*/
|
||||
export interface KubernetesObjectsProviderExtensionPoint {
|
||||
addObjectsProvider(
|
||||
provider:
|
||||
| KubernetesObjectsProvider
|
||||
| (({
|
||||
getDefault,
|
||||
clusterSupplier,
|
||||
serviceLocator,
|
||||
customResources,
|
||||
objectTypesToFetch,
|
||||
authStrategy,
|
||||
}: {
|
||||
getDefault: () => KubernetesObjectsProvider;
|
||||
clusterSupplier: KubernetesClustersSupplier;
|
||||
serviceLocator: KubernetesServiceLocator;
|
||||
customResources: CustomResource[];
|
||||
objectTypesToFetch?: ObjectToFetch[];
|
||||
authStrategy: AuthenticationStrategy;
|
||||
}) => KubernetesObjectsProvider),
|
||||
provider: KubernetesObjectsProvider | KubernetesObjectsProviderFactory,
|
||||
): void;
|
||||
}
|
||||
|
||||
@@ -61,6 +59,15 @@ export const kubernetesObjectsProviderExtensionPoint =
|
||||
id: 'kubernetes.objects-provider',
|
||||
});
|
||||
|
||||
/**
|
||||
* A factory function for creating a KubernetesClustersSupplier.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export type KubernetesClusterSupplierFactory = (opts: {
|
||||
getDefault: () => Promise<KubernetesClustersSupplier>;
|
||||
}) => Promise<KubernetesClustersSupplier>;
|
||||
|
||||
/**
|
||||
* The interface for {@link kubernetesClusterSupplierExtensionPoint}.
|
||||
*
|
||||
@@ -70,11 +77,7 @@ export interface KubernetesClusterSupplierExtensionPoint {
|
||||
addClusterSupplier(
|
||||
clusterSupplier:
|
||||
| KubernetesClustersSupplier
|
||||
| (({
|
||||
getDefault,
|
||||
}: {
|
||||
getDefault: () => KubernetesClustersSupplier;
|
||||
}) => KubernetesClustersSupplier),
|
||||
| KubernetesClusterSupplierFactory,
|
||||
): void;
|
||||
}
|
||||
|
||||
@@ -107,21 +110,22 @@ export const kubernetesAuthStrategyExtensionPoint =
|
||||
id: 'kubernetes.auth-strategy',
|
||||
});
|
||||
|
||||
/**
|
||||
* A factory function for creating a KubernetesFetcher.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export type KubernetesFetcherFactory = (opts: {
|
||||
getDefault: () => Promise<KubernetesFetcher>;
|
||||
}) => Promise<KubernetesFetcher>;
|
||||
|
||||
/**
|
||||
* The interface for {@link kubernetesFetcherExtensionPoint}.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export interface KubernetesFetcherExtensionPoint {
|
||||
addFetcher(
|
||||
fetcher:
|
||||
| KubernetesFetcher
|
||||
| (({
|
||||
getDefault,
|
||||
}: {
|
||||
getDefault: () => KubernetesFetcher;
|
||||
}) => KubernetesFetcher),
|
||||
): void;
|
||||
addFetcher(fetcher: KubernetesFetcher | KubernetesFetcherFactory): void;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -134,6 +138,16 @@ export const kubernetesFetcherExtensionPoint =
|
||||
id: 'kubernetes.fetcher',
|
||||
});
|
||||
|
||||
/**
|
||||
* A factory function for creating a KubernetesServiceLocator.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export type KubernetesServiceLocatorFactory = (opts: {
|
||||
getDefault: () => Promise<KubernetesServiceLocator>;
|
||||
clusterSupplier: KubernetesClustersSupplier;
|
||||
}) => Promise<KubernetesServiceLocator>;
|
||||
|
||||
/**
|
||||
* The interface for {@link kubernetesServiceLocatorExtensionPoint}.
|
||||
*
|
||||
@@ -141,15 +155,7 @@ export const kubernetesFetcherExtensionPoint =
|
||||
*/
|
||||
export interface KubernetesServiceLocatorExtensionPoint {
|
||||
addServiceLocator(
|
||||
serviceLocator:
|
||||
| KubernetesServiceLocator
|
||||
| (({
|
||||
getDefault,
|
||||
clusterSupplier,
|
||||
}: {
|
||||
getDefault: () => KubernetesServiceLocator;
|
||||
clusterSupplier: KubernetesClustersSupplier;
|
||||
}) => KubernetesServiceLocator),
|
||||
serviceLocator: KubernetesServiceLocator | KubernetesServiceLocatorFactory,
|
||||
): void;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user