LegacyTitledEnumSchema

data class LegacyTitledEnumSchema(val title: String? = null, val description: String? = null, val enumValues: List<String>, val enumNames: List<String>? = null, val default: String? = null) : EnumSchemaDefinition(source)

Deprecated

Use TitledSingleSelectEnumSchema instead

Defines a single-selection enumeration with display names via the deprecated enumNames array.

Use TitledSingleSelectEnumSchema instead. This class will be removed in a future version.

Constructors

Link copied to clipboard
constructor(title: String? = null, description: String? = null, enumValues: List<String>, enumNames: List<String>? = null, default: String? = null)

Properties

Link copied to clipboard

Optional default value.

Link copied to clipboard

Optional description for the field.

Link copied to clipboard

Display names for enum values. Non-standard according to JSON Schema 2020-12.

Link copied to clipboard
@SerialName(value = "enum")
val enumValues: List<String>

Array of enum values to choose from.

Link copied to clipboard

Optional display title for the field.

Link copied to clipboard

JSON Schema type discriminator, always "string".