getExampleValue

fun getExampleValue(name: String, schema: Schema<*>, openAPI: OpenAPI, variationIndex: Int = 0): Any

Retrieves the example value for a given parameter based on its schema.

Behavior:

  • When variationIndex is 0, schema-level example is returned when present.

  • Otherwise, composed schemas are merged before value generation.

Return

example value matching the schema

Parameters

name

parameter name (used in error messages)

schema

parameter schema (may be a $ref)

openAPI

OpenAPI model used to resolve references

variationIndex

index used to generate varied values

Throws

if no provider can generate a value