kotlinx-schema-json/kotlinx.schema.json/AnyOfPropertyBuilder

AnyOfPropertyBuilder

class AnyOfPropertyBuilder : PolymorphicOptionsCollector(source)

Builder for AnyOfPropertyDefinition.

Configures anyOf schema composition where one or more schemas must match. Unlike oneOf, the value can satisfy multiple schemas simultaneously.

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

Example

property("identifier") {
    anyOf {
        description = "Can be UUID or integer ID"
        string {
            format = "uuid"
            description = "UUID identifier"
        }
        integer {
            minimum = 1.0
            description = "Numeric identifier"
        }
    }
}

See also

PropertyBuilder.anyOf

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(): AnyOfPropertyDefinition

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.