Enum Class ApiValidationDepth

java.lang.Object
java.lang.Enum<ApiValidationDepth>
com.shaft.capture.generate.api.ApiValidationDepth
All Implemented Interfaces:
Serializable, Comparable<ApiValidationDepth>, Constable
public enum ApiValidationDepth extends Enum<ApiValidationDepth>
How thoroughly generated code validates each response.

  • Enum Constant Details

    • STATUS

      public static final ApiValidationDepth STATUS
      Only the recorded HTTP status code is asserted (via setTargetStatusCode).

    • STATUS_HEADERS

      public static final ApiValidationDepth STATUS_HEADERS
      STATUS plus an assertion on every response header classified LeafClassification.STABLE (sensitive headers are never asserted; volatile ones would flake on replay, so both are skipped).

    • SCHEMA

      public static final ApiValidationDepth SCHEMA
      STATUS plus a matchesSchema assertion against a schema inferred by JsonSchemaInferencer from the recorded response body.

    • FULL_BODY

      public static final ApiValidationDepth FULL_BODY
      STATUS plus a full-body isEqualToFileContentIgnoringOrder assertion against a normalized golden file (volatile/correlated leaves replaced with a stable placeholder, sensitive leaves masked, so the assertion doesn't flake on values that legitimately change every run).

    • BUSINESS

      public static final ApiValidationDepth BUSINESS
      STATUS plus a targeted business-value assertion on every response leaf classified LeafClassification.STABLE, asserting the recorded value at its JSON path via getResponseJSONValue. Volatile, correlated, and sensitive leaves are skipped so the generated test pins only the business-meaningful fields that a human would check, without flaking on generated IDs/timestamps or leaking secrets. This is the assertion model the business-logic recorder (#3499) uses for chained domain scenarios.

  • Method Details

    • values

      public static ApiValidationDepth[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ApiValidationDepth valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null