kotlinx-schema-json/kotlinx.schema.json/PropertyBuilder

PropertyBuilder

class PropertyBuilder(source)

Builder for defining property types and constraints.

This builder provides methods to specify the type of a property (string, number, boolean, array, object, etc.) along with its constraints. Use the required flag to mark properties as required in the schema.

Supported Property Types

string - String properties with format, pattern, length constraints
integer - Integer numeric properties
number - Numeric properties (including decimals)
boolean - Boolean properties
array - Array properties with item type definitions
obj - Nested object properties
reference - Schema references ($ref)

Example

property("status") {
    required = true
    string {
        description = "Current status"
        enum = listOf("active", "inactive", "pending")
    }
}

See also

JsonSchemaDefinitionBuilder.property

Constructors

PropertyBuilder

constructor()

Properties

var required: Boolean

Marks this property as required in the parent schema.

Functions

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

Creates an array property definition.

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

Creates a boolean property definition.

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

Creates an integer property definition.

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

Creates a numeric property definition (supports decimals).

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

Creates a nested object property definition.

fun reference(ref: String): ReferencePropertyDefinition

Creates a reference to another schema definition.

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

Creates a string property definition.