kotlinx-schema-json/kotlinx.schema.json/AllOfPropertyBuilder

AllOfPropertyBuilder

class AllOfPropertyBuilder : PolymorphicOptionsCollector(source)

Builder for AllOfPropertyDefinition.

Configures allOf schema composition where all schemas must match. Commonly used for schema composition, extension, and inheritance patterns.

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

Example - Schema Extension

property("adminUser") {
    allOf {
        description = "Admin user with base properties plus admin-specific properties"
        reference("#/definitions/BaseUser")
        obj {
            property("permissions") {
                required = true
                array {
                    ofString()
                }
            }
        }
    }
}

See also

PropertyBuilder.allOf

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

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.