example-value/art.galushko.openapi.testgen.example.config/ExampleValueSettings

ExampleValueSettings

data class ExampleValueSettings(val providers: List<String> = DEFAULT_PROVIDER_ORDER, val maxExampleDepth: Int = SchemaExampleValueGeneratorOptions.DEFAULT_MAX_EXAMPLE_DEPTH, val includeOptionalExampleProperties: Boolean = SchemaExampleValueGeneratorOptions.DEFAULT_INCLUDE_OPTIONAL_EXAMPLES, val includeWriteOnly: Boolean = SchemaExampleValueGeneratorOptions.DEFAULT_INCLUDE_WRITE_ONLY, val useSchemaExampleFallback: Boolean = SchemaExampleValueGeneratorOptions.DEFAULT_USE_SCHEMA_EXAMPLE_FALLBACK, val uuid: UuidProviderSettings = UuidProviderSettings(), val email: EmailProviderSettings = EmailProviderSettings(), val date: DateProviderSettings = DateProviderSettings(), val dateTime: DateTimeProviderSettings = DateTimeProviderSettings(), val plainString: PlainStringProviderSettings = PlainStringProviderSettings(), val fullExample: Boolean = SchemaExampleValueGeneratorOptions.DEFAULT_FULL_EXAMPLE)

Configuration for schema example value generation.

Controls how synthetic test data is generated from OpenAPI schemas when building valid baselines and when providers need schema-derived values.

Constructors

constructor(providers: List<String> = DEFAULT_PROVIDER_ORDER, maxExampleDepth: Int = SchemaExampleValueGeneratorOptions.DEFAULT_MAX_EXAMPLE_DEPTH, includeOptionalExampleProperties: Boolean = SchemaExampleValueGeneratorOptions.DEFAULT_INCLUDE_OPTIONAL_EXAMPLES, includeWriteOnly: Boolean = SchemaExampleValueGeneratorOptions.DEFAULT_INCLUDE_WRITE_ONLY, useSchemaExampleFallback: Boolean = SchemaExampleValueGeneratorOptions.DEFAULT_USE_SCHEMA_EXAMPLE_FALLBACK, uuid: UuidProviderSettings = UuidProviderSettings(), email: EmailProviderSettings = EmailProviderSettings(), date: DateProviderSettings = DateProviderSettings(), dateTime: DateTimeProviderSettings = DateTimeProviderSettings(), plainString: PlainStringProviderSettings = PlainStringProviderSettings(), fullExample: Boolean = SchemaExampleValueGeneratorOptions.DEFAULT_FULL_EXAMPLE)

Types

Companion

object Companion

Properties

date

val date: DateProviderSettings

Date provider settings.

dateTime

val dateTime: DateTimeProviderSettings

Date-time provider settings.

val email: EmailProviderSettings

Email provider settings.

fullExample

val fullExample: Boolean

When true, generated examples are "full": every declared property is populated (required and optional, regardless of explicit examples) and every array contains at least one item. Composed schemas collapse to a single variant. includeWriteOnly and depth/cycle guards still apply.

includeOptionalExampleProperties

val includeOptionalExampleProperties: Boolean

When true, optional properties with explicit examples/defaults are included for object examples.

includeWriteOnly

val includeWriteOnly: Boolean

When false, writeOnly properties are excluded from generated examples.

maxExampleDepth

val maxExampleDepth: Int

Maximum depth for recursive schema traversal while generating examples.

plainString

val plainString: PlainStringProviderSettings

Plain string provider settings.