example-value/art.galushko.openapi.testgen.example.generator/SchemaExampleValueGeneratorOptions

SchemaExampleValueGeneratorOptions

data class SchemaExampleValueGeneratorOptions(val maxExampleDepth: Int = DEFAULT_MAX_EXAMPLE_DEPTH, val includeOptionalExampleProperties: Boolean = DEFAULT_INCLUDE_OPTIONAL_EXAMPLES, val includeWriteOnly: Boolean = DEFAULT_INCLUDE_WRITE_ONLY, val useSchemaExampleFallback: Boolean = DEFAULT_USE_SCHEMA_EXAMPLE_FALLBACK, val fullExample: Boolean = DEFAULT_FULL_EXAMPLE)

Configuration options for SchemaExampleValueGenerator.

Controls the behavior of example value generation from OpenAPI schemas.

Java callers: start from REQUEST_DEFAULTS or RESPONSE_DEFAULTS and adjust via the with* methods instead of the positional constructor:

var options = SchemaExampleValueGeneratorOptions.RESPONSE_DEFAULTS.withFullExample(true);

Note: when a generator is used through the ResponseExampleExtractor(SchemaExampleValueGenerator) constructor, response extraction applies RESPONSE_DEFAULTS for the include/fallback flags and only honors maxExampleDepth and fullExample from the configured options.

Constructors

SchemaExampleValueGeneratorOptions

constructor(maxExampleDepth: Int = DEFAULT_MAX_EXAMPLE_DEPTH, includeOptionalExampleProperties: Boolean = DEFAULT_INCLUDE_OPTIONAL_EXAMPLES, includeWriteOnly: Boolean = DEFAULT_INCLUDE_WRITE_ONLY, useSchemaExampleFallback: Boolean = DEFAULT_USE_SCHEMA_EXAMPLE_FALLBACK, fullExample: Boolean = DEFAULT_FULL_EXAMPLE)

Types

Companion

object Companion

Properties

fullExample

val fullExample: Boolean

When true, generates a complete example: every declared property (required and optional, regardless of explicit examples) is populated, and every array contains at least one item. For composed schemas (oneOf/anyOf), a single variant is produced. includeWriteOnly and depth/cycle guards still apply.