chore: document baseline details

packages/validation/src/MonokleValidator.ts

@@ -32,6 +32,35 @@ const DEFAULT_PLUGIN_MAP = {
   'kubernetes-schema': true,
 };
 
+type ValidateParams = {
+  /**
+   * The resources that will be validated.
+   */
+  resources: Resource[];
+
+  /**
+   * The list of resources that recently got updated.
+   *
+   * @remarks Validators can use this information to skip non-modified resources.
+   */
+  incremental?: Incremental;
+
+  /**
+   * A previous run which acts as the baseline for detected problems.
+   *
+   * @remark Providing a baseline will set run.baselineGuid and result.baselineStatus.
+   * @remark Newly fixed problems will be added as 'absent' results.
+   * When using baseline, it is important to properly filter or
+   * indicate absent results or they appear as false positives.
+   */
+  baseline?: ValidationResponse;
+
+  /**
+   * A signal that can be used to abort processing.
+   */
+  abortSignal?: AbortSignal;
+};
+
 export class MonokleValidator implements Validator {
   /**
    * The user configuration of this validator.
@@ -241,12 +270,7 @@ export class MonokleValidator implements Validator {
     incremental,
     baseline,
     abortSignal: externalAbortSignal,
-  }: {
-    resources: Resource[];
-    incremental?: Incremental;
-    baseline?: ValidationResponse;
-    abortSignal?: AbortSignal;
-  }): Promise<ValidationResponse> {
+  }: ValidateParams): Promise<ValidationResponse> {
     if (this._loading === undefined) {
       this.load();
     }