fix api-reports

Signed-off-by: goenning <me@goenning.net>

plugins/kubernetes/src/error-detection/error-detection.ts

@@ -21,8 +21,12 @@ import { detectErrorsInPods } from './pods';
 import { detectErrorsInDeployments } from './deployments';
 import { detectErrorsInHpa } from './hpas';
 
-// For each cluster try to find errors in each of the object types provided
-// returning a map of cluster names to errors in that cluster
+/**
+ * For each cluster try to find errors in each of the object types provided
+ * returning a map of cluster names to errors in that cluster
+ *
+ * @alpha
+ */
 export const detectErrors = (
   objects: ObjectsByEntityResponse,
 ): DetectedErrorsByCluster => {

plugins/kubernetes/src/error-detection/index.ts

@@ -14,5 +14,10 @@
  * limitations under the License.
  */
 
-export type { DetectedError, DetectedErrorsByCluster } from './types';
+export type {
+  ErrorDetectableKind,
+  DetectedError,
+  DetectedErrorsByCluster,
+  ErrorSeverity,
+} from './types';
 export { detectErrors } from './error-detection';

plugins/kubernetes/src/error-detection/types.ts

@@ -21,17 +21,37 @@ import {
   V1Pod,
 } from '@kubernetes/client-node';
 
+/**
+ * Severity of the error, where 10 is critical and 0 is very low.
+ *
+ * @alpha
+ */
 export type ErrorSeverity = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
 
 export type ErrorDetectable = V1Pod | V1Deployment | V1HorizontalPodAutoscaler;
 
+/**
+ * Kubernetes kinds that errors might be reported by the plugin
+ *
+ * @alpha
+ */
 export type ErrorDetectableKind =
   | 'Pod'
   | 'Deployment'
   | 'HorizontalPodAutoscaler';
 
+/**
+ * A list of errors keyed by Cluster name
+ *
+ * @alpha
+ */
 export type DetectedErrorsByCluster = Map<string, DetectedError[]>;
 
+/**
+ * Represents an error found on a Kubernetes object
+ *
+ * @alpha
+ */
 export interface DetectedError {
   severity: ErrorSeverity;
   cluster: string;