kotlinx-schema-json/kotlinx.schema.json/ArrayPropertyBuilder

ArrayPropertyBuilder

class ArrayPropertyBuilder(source)

Builder for ArrayPropertyDefinition.

Configures array-type properties with item type definitions and size constraints. Provides convenient methods for specifying item types using ofString(), ofObject(), etc. Supports automatic conversion of List values to JsonArray.

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

Array of Strings

property("tags") {
    array {
        description = "List of tags"
        minItems = 1
        maxItems = 10
        ofString()
    }
}

Array of Objects

property("steps") {
    array {
        description = "Processing steps"
        ofObject {
            additionalProperties = false
            property("explanation") {
                required = true
                string {
                    description = "Step explanation"
                }
            }
            property("output") {
                required = true
                string {
                    description = "Step output"
                }
            }
        }
    }
}

See also

PropertyBuilder.array

Properties

var default: Any?

Default value for this property.

var description: String?

Human-readable description of this property.

var maxItems: Int?

Maximum number of items in the array.

var minItems: Int?

Minimum number of items in the array.

var nullable: Boolean?

Whether null values are allowed.

var type: List<String>

The JSON Schema type. Always "array" for this builder.

Functions

fun build(): ArrayPropertyDefinition

fun items(block: PropertyBuilder.() -> PropertyDefinition)

Defines the type of items in the array using a generic property builder. Consider using the of*() convenience methods instead.

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

Specifies that array items are arrays (nested arrays).

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

Specifies that array items are booleans.

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

Specifies that array items are integers.

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

Specifies that array items are numbers (supports decimals).

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

Specifies that array items are objects.

fun ofReference(ref: String)

Specifies that array items reference another schema definition.

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

Specifies that array items are strings.