ktor-openapi-schema/io.ktor.openapi/JsonSchema/Discriminator

Discriminator

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class Discriminator(val property: String, val mapping: JsonSchema.Discriminator.Mapping)(source)

Configures polymorphism using a discriminator property and optional explicit mappings.

Report a problem

Types

annotation class Mapping(val key: String, val ref: KClass<*>)

Key-value pair for discriminator mappings (name -> $ref / schema id).

Properties

val mapping: Array<out JsonSchema.Discriminator.Mapping>

An array of Mapping annotations defining the relationship between discriminator values and schema classes.

val property: String

The name of the property in the payload used to identify the type.