update api report

Signed-off-by: Matthew Clarke <mclarke@spotify.com>
This commit is contained in:
Matthew Clarke
2022-09-15 22:03:09 -04:00
parent b87a88776d
commit 29dd35cdcb
3 changed files with 35 additions and 3 deletions
+1 -3
View File
@@ -8,6 +8,7 @@ import { Config } from '@backstage/config';
import { CoreV1Api } from '@kubernetes/client-node';
import { Credentials } from 'aws-sdk';
import { CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomResourceMatcher } from '@backstage/plugin-kubernetes-common';
import { Duration } from 'luxon';
import { Entity } from '@backstage/catalog-model';
import express from 'express';
@@ -101,9 +102,6 @@ export interface CustomResource extends ObjectToFetch {
objectType: 'customresources';
}
// @alpha (undocumented)
export type CustomResourceMatcher = Omit<ObjectToFetch, 'objectType'>;
// @alpha (undocumented)
export interface CustomResourcesByEntity extends KubernetesObjectsByEntity {
// (undocumented)
+10
View File
@@ -97,6 +97,16 @@ export interface CustomResourceFetchResponse {
type: 'customresources';
}
// @public (undocumented)
export interface CustomResourceMatcher {
// (undocumented)
apiVersion: string;
// (undocumented)
group: string;
// (undocumented)
plural: string;
}
// @public (undocumented)
export interface DaemonSetsFetchResponse {
// (undocumented)
+24
View File
@@ -10,10 +10,12 @@ import { BackstagePlugin } from '@backstage/core-plugin-api';
import { ClientPodStatus } from '@backstage/plugin-kubernetes-common';
import { ClusterAttributes } from '@backstage/plugin-kubernetes-common';
import { ClusterObjects } from '@backstage/plugin-kubernetes-common';
import { CustomResourceMatcher } from '@backstage/plugin-kubernetes-common';
import { DiscoveryApi } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { IdentityApi } from '@backstage/core-plugin-api';
import type { JsonObject } from '@backstage/types';
import { KubernetesRequestAuth } from '@backstage/plugin-kubernetes-common';
import { KubernetesRequestBody } from '@backstage/plugin-kubernetes-common';
import { OAuthApi } from '@backstage/core-plugin-api';
import { ObjectsByEntityResponse } from '@backstage/plugin-kubernetes-common';
@@ -245,9 +247,20 @@ export interface KubernetesApi {
}[]
>;
// (undocumented)
getCustomObjectsByEntity(
auth: KubernetesRequestAuth,
customResources: CustomResourceMatcher[],
entity: Entity,
): Promise<ObjectsByEntityResponse>;
// (undocumented)
getObjectsByEntity(
requestBody: KubernetesRequestBody,
): Promise<ObjectsByEntityResponse>;
// (undocumented)
getWorkloadsByEntity(
auth: KubernetesRequestAuth,
entity: Entity,
): Promise<ObjectsByEntityResponse>;
}
// Warning: (ae-missing-release-tag) "kubernetesApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -304,9 +317,20 @@ export class KubernetesBackendClient implements KubernetesApi {
}[]
>;
// (undocumented)
getCustomObjectsByEntity(
auth: KubernetesRequestAuth,
customResources: CustomResourceMatcher[],
entity: Entity,
): Promise<ObjectsByEntityResponse>;
// (undocumented)
getObjectsByEntity(
requestBody: KubernetesRequestBody,
): Promise<ObjectsByEntityResponse>;
// (undocumented)
getWorkloadsByEntity(
auth: KubernetesRequestAuth,
entity: Entity,
): Promise<ObjectsByEntityResponse>;
}
// Warning: (ae-forgotten-export) The symbol "KubernetesContentProps" needs to be exported by the entry point index.d.ts