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.

Constructors

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.

includeOptionalExampleProperties

val includeOptionalExampleProperties: Boolean

When true, includes optional properties that have explicit examples

includeWriteOnly

val includeWriteOnly: Boolean

When false, excludes writeOnly properties (appropriate for response examples)

maxExampleDepth

val maxExampleDepth: Int

Maximum depth for recursive schema traversal (default: 50)

useSchemaExampleFallback

val useSchemaExampleFallback: Boolean

When true, falls back to schema.examples and schema.default if no example found