kotlinx-schema-json/kotlinx.schema.json/OneOfPropertyBuilder

OneOfPropertyBuilder

class OneOfPropertyBuilder : PolymorphicOptionsCollector(source)

Builder for OneOfPropertyDefinition.

Configures oneOf schema composition where exactly one schema must match. Supports optional discriminator for efficient polymorphic type resolution.

This class is part of the JSON Schema DSL and cannot be instantiated directly. Use PropertyBuilder.oneOf instead within the DSL context.

Example - Basic oneOf

property("contact") {
    oneOf {
        description = "Email or phone contact"
        obj {
            property("email") {
                required = true
                string { format = "email" }
            }
        }
        obj {
            property("phone") {
                required = true
                string()
            }
        }
    }
}

See also

PropertyBuilder.oneOf

Properties

var description: String?

Human-readable description of this property.

Functions

fun PolymorphicOptionsCollector.allOf(block: AllOfPropertyBuilder.() -> Unit = {})

Adds a nested allOf schema option.

fun PolymorphicOptionsCollector.anyOf(block: AnyOfPropertyBuilder.() -> Unit = {})

Adds a nested anyOf schema option.

fun PolymorphicOptionsCollector.array(block: ArrayPropertyBuilder.() -> Unit = {})

Adds an array schema option.

fun PolymorphicOptionsCollector.boolean(block: BooleanPropertyBuilder.() -> Unit = {})

Adds a boolean schema option.

fun build(): OneOfPropertyDefinition

fun discriminator(propertyName: String, block: DiscriminatorBuilder.() -> Unit = {})

Configures the discriminator for this oneOf.

fun PolymorphicOptionsCollector.integer(block: NumericPropertyBuilder.() -> Unit = {})

Adds an integer schema option.

fun PolymorphicOptionsCollector.number(block: NumericPropertyBuilder.() -> Unit = {})

Adds a number schema option.

fun PolymorphicOptionsCollector.obj(block: ObjectPropertyBuilder.() -> Unit = {})

Adds an object schema option.

fun PolymorphicOptionsCollector.oneOf(block: OneOfPropertyBuilder.() -> Unit = {})

Adds a nested oneOf schema option.

fun PolymorphicOptionsCollector.reference(ref: String)

Adds a reference schema option.

fun PolymorphicOptionsCollector.string(block: StringPropertyBuilder.() -> Unit = {})

Adds a string schema option.