kotlinx-schema-json/kotlinx.schema.json/StringPropertyBuilder

StringPropertyBuilder

Configures string-type properties with various constraints like format, length, pattern matching, and enumeration. Supports automatic type conversion for default and constant values.

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

Basic String Property

property("email") {
    string {
        description = "Email address"
        format = "email"
    }
}

String with Length Constraints

property("username") {
    string {
        minLength = 3
        maxLength = 20
        pattern = "^[a-zA-Z0-9_]+$"
    }
}

String Enum

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

String with Default Value

property("name") {
    string {
        description = "Config name"
        default = "default"
    }
}

String with Constant Value

property("version") {
    string {
        description = "API version"
        constValue = "v1.0"
    }
}

Properties

constValue

var constValue: Any?

Constant value for this property.

default

var default: Any?

Default value for this property.

description

var description: String?

Human-readable description of this property.

enum

var enum: List<String>?

List of allowed string values (enumeration).

format

var format: String?

Format specification (e.g., "email", "uri", "date-time", "uuid").

maxLength

var maxLength: Int?

Maximum string length constraint.

minLength

var minLength: Int?

Minimum string length constraint.

nullable

var nullable: Boolean?

Whether null values are allowed.

pattern

var pattern: String?

Regular expression pattern the string must match.

type

var type: List<String>

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

Functions

build

fun build(): StringPropertyDefinition