kotlinx-schema-json/kotlinx.schema.json

Package-level declarations

JSON Schema models, DSL builders, and function calling schema support.

Types

AdditionalPropertiesConstraint

@Serializable(with = AdditionalPropertiesSerializer::class)

sealed interface AdditionalPropertiesConstraint

Represents the constraint for additional properties in a JSON Schema object.

AdditionalPropertiesSchema

@Serializable

data class AdditionalPropertiesSchema(val schema: PropertyDefinition) : AdditionalPropertiesConstraint

Additional properties must conform to the specified schema. Corresponds to "additionalProperties": { <schema> } in JSON Schema.

AllOfPropertyBuilder

class AllOfPropertyBuilder : PolymorphicOptionsCollector

Builder for AllOfPropertyDefinition.

AllOfPropertyDefinition

@Serializable

data class AllOfPropertyDefinition(val allOf: List<PropertyDefinition>, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val type: List<String>? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val enum: List<JsonElement>? = null, val minLength: Int? = null, val maxLength: Int? = null, val pattern: String? = null, val format: String? = null, val contentEncoding: String? = null, val contentMediaType: String? = null, val contentSchema: PropertyDefinition? = null, val minimum: Double? = null, val maximum: Double? = null, val exclusiveMinimum: Double? = null, val exclusiveMaximum: Double? = null, val multipleOf: Double? = null, val properties: Map<String, PropertyDefinition>? = null, val patternProperties: Map<String, PropertyDefinition>? = null, val additionalProperties: AdditionalPropertiesConstraint? = null, val unevaluatedProperties: PropertyDefinition? = null, val propertyNames: PropertyDefinition? = null, val required: List<String>? = null, val dependentRequired: Map<String, List<String>>? = null, val dependentSchemas: Map<String, PropertyDefinition>? = null, val minProperties: Int? = null, val maxProperties: Int? = null, val items: PropertyDefinition? = null, val prefixItems: List<PropertyDefinition>? = null, val unevaluatedItems: PropertyDefinition? = null, val contains: PropertyDefinition? = null, val minContains: Int? = null, val maxContains: Int? = null, val minItems: Int? = null, val maxItems: Int? = null, val uniqueItems: Boolean? = null, val ref: String? = null, val dynamicRef: String? = null) : PropertyDefinition, CommonSchemaAttributes, ApplicatorContainer, GeneralConstraints

Represents an allOf schema composition.

AllowAdditionalProperties

@Serializable

data object AllowAdditionalProperties : AdditionalPropertiesConstraint

Allows any additional properties beyond those explicitly defined. Corresponds to "additionalProperties": true in JSON Schema.

AnyOfPropertyBuilder

class AnyOfPropertyBuilder : PolymorphicOptionsCollector

Builder for AnyOfPropertyDefinition.

AnyOfPropertyDefinition

@Serializable

data class AnyOfPropertyDefinition(val anyOf: List<PropertyDefinition>, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val type: List<String>? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val enum: List<JsonElement>? = null, val minLength: Int? = null, val maxLength: Int? = null, val pattern: String? = null, val format: String? = null, val contentEncoding: String? = null, val contentMediaType: String? = null, val contentSchema: PropertyDefinition? = null, val minimum: Double? = null, val maximum: Double? = null, val exclusiveMinimum: Double? = null, val exclusiveMaximum: Double? = null, val multipleOf: Double? = null, val properties: Map<String, PropertyDefinition>? = null, val patternProperties: Map<String, PropertyDefinition>? = null, val additionalProperties: AdditionalPropertiesConstraint? = null, val unevaluatedProperties: PropertyDefinition? = null, val propertyNames: PropertyDefinition? = null, val required: List<String>? = null, val dependentRequired: Map<String, List<String>>? = null, val dependentSchemas: Map<String, PropertyDefinition>? = null, val minProperties: Int? = null, val maxProperties: Int? = null, val items: PropertyDefinition? = null, val prefixItems: List<PropertyDefinition>? = null, val unevaluatedItems: PropertyDefinition? = null, val contains: PropertyDefinition? = null, val minContains: Int? = null, val maxContains: Int? = null, val minItems: Int? = null, val maxItems: Int? = null, val uniqueItems: Boolean? = null, val ref: String? = null, val dynamicRef: String? = null) : PropertyDefinition, CommonSchemaAttributes, ApplicatorContainer, GeneralConstraints

Represents an anyOf schema composition.

ApplicatorContainer

interface ApplicatorContainer

Interface for schemas that can be composed of other schemas.

ArrayContainer

interface ArrayContainer

Interface representing a container for items in a JSON array schema.

ArrayPropertyBuilder

class ArrayPropertyBuilder

Builder for ArrayPropertyDefinition.

ArrayPropertyDefinition

@Serializable

data class ArrayPropertyDefinition(val type: List<String> = ARRAY_TYPE, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val ref: String? = null, val dynamicRef: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val enum: List<JsonArray>? = null, val items: PropertyDefinition? = null, val prefixItems: List<PropertyDefinition>? = null, val unevaluatedItems: PropertyDefinition? = null, val contains: PropertyDefinition? = null, val minContains: Int? = null, val maxContains: Int? = null, val minItems: Int? = null, val maxItems: Int? = null, val uniqueItems: Boolean? = null) : ValuePropertyDefinition<JsonArray> , ArrayContainer

Represents an array property

BooleanPropertyBuilder

class BooleanPropertyBuilder

Builder for BooleanPropertyDefinition.

BooleanPropertyDefinition

@Serializable

data class BooleanPropertyDefinition(val type: List<String> = BOOLEAN_TYPE, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val ref: String? = null, val dynamicRef: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val enum: List<Boolean>? = null) : ValuePropertyDefinition<Boolean>

Represents a boolean property

BooleanSchemaDefinition

@Serializable

data class BooleanSchemaDefinition(val value: Boolean) : PropertyDefinition

Represents a boolean schema in JSON Schema.

CommonSchemaAttributes

interface CommonSchemaAttributes

Common keywords for all object-based JSON schemas.

DenyAdditionalProperties

@Serializable

data object DenyAdditionalProperties : AdditionalPropertiesConstraint

Disallows any additional properties beyond those explicitly defined. Corresponds to "additionalProperties": false in JSON Schema.

Discriminator

@Serializable

data class Discriminator(val propertyName: String = "type", val mapping: Map<String, String>? = null)

Represents a discriminator for polymorphic schemas.

DiscriminatorBuilder

class DiscriminatorBuilder

Builder for Discriminator.

FunctionCallingSchema

@Serializable

data class FunctionCallingSchema(val type: String = "function", val name: String, val title: String? = null, val description: String? = null, val strict: Boolean? = true, val parameters: ObjectPropertyDefinition)

FunctionCallingSchema describes a function/tool call in LLM function calling APIs.

GeneralConstraints

interface GeneralConstraints : PropertiesContainer, ArrayContainer, NumericConstraints, StringConstraints

Combined interface for all structural validation keywords.

GenericPropertyBuilder

class GenericPropertyBuilder

Builder for GenericPropertyDefinition.

GenericPropertyDefinition

@Serializable

data class GenericPropertyDefinition(val type: List<String>? = null, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val ref: String? = null, val dynamicRef: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val enum: List<JsonElement>? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val properties: Map<String, PropertyDefinition>? = null, val patternProperties: Map<String, PropertyDefinition>? = null, val additionalProperties: AdditionalPropertiesConstraint? = null, val propertyNames: PropertyDefinition? = null, val required: List<String>? = null, val dependentRequired: Map<String, List<String>>? = null, val dependentSchemas: Map<String, PropertyDefinition>? = null, val dependencies: Map<String, JsonElement>? = null, val unevaluatedItems: PropertyDefinition? = null, val unevaluatedProperties: PropertyDefinition? = null, val items: PropertyDefinition? = null, val prefixItems: List<PropertyDefinition>? = null, val contains: PropertyDefinition? = null, val minContains: Int? = null, val maxContains: Int? = null, val minLength: Int? = null, val maxLength: Int? = null, val pattern: String? = null, val format: String? = null, val contentEncoding: String? = null, val contentMediaType: String? = null, val contentSchema: PropertyDefinition? = null, val minimum: Double? = null, val maximum: Double? = null, val exclusiveMinimum: Double? = null, val exclusiveMaximum: Double? = null, val multipleOf: Double? = null, val minItems: Int? = null, val maxItems: Int? = null, val uniqueItems: Boolean? = null, val minProperties: Int? = null, val maxProperties: Int? = null) : ValuePropertyDefinition<JsonElement> , GeneralConstraints

Represents a property definition without specific type constraints.

JsonSchema

@Serializable

data class JsonSchema(val schema: String? = null, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val ref: String? = null, val dynamicRef: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val type: List<String> = OBJECT_TYPE, val enum: List<JsonElement>? = null, val constValue: JsonElement? = null, val default: JsonElement? = null, val properties: Map<String, PropertyDefinition> = emptyMap(), val patternProperties: Map<String, PropertyDefinition>? = null, val additionalProperties: AdditionalPropertiesConstraint? = null, val unevaluatedProperties: PropertyDefinition? = null, val propertyNames: PropertyDefinition? = null, val required: List<String> = emptyList(), val dependentRequired: Map<String, List<String>>? = null, val dependentSchemas: Map<String, PropertyDefinition>? = null, val dependencies: Map<String, JsonElement>? = null, val minProperties: Int? = null, val maxProperties: Int? = null, val items: PropertyDefinition? = null, val prefixItems: List<PropertyDefinition>? = null, val unevaluatedItems: PropertyDefinition? = null, val contains: PropertyDefinition? = null, val minContains: Int? = null, val maxContains: Int? = null, val minItems: Int? = null, val maxItems: Int? = null, val uniqueItems: Boolean? = null, val minLength: Int? = null, val maxLength: Int? = null, val pattern: String? = null, val format: String? = null, val contentEncoding: String? = null, val contentMediaType: String? = null, val contentSchema: PropertyDefinition? = null, val minimum: Double? = null, val maximum: Double? = null, val exclusiveMinimum: Double? = null, val exclusiveMaximum: Double? = null, val multipleOf: Double? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val not: PropertyDefinition? = null, val discriminator: Discriminator? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val nullable: Boolean? = null, val defs: Map<String, PropertyDefinition>? = null) : GeneralConstraints, CommonSchemaAttributes, ApplicatorContainer, PropertyDefinition

Represents a JSON Schema with validation constraints and metadata according to the JSON Schema specification.

JsonSchemaBuilder

class JsonSchemaBuilder

Builder for JsonSchema.

JsonSchemaConstants

object JsonSchemaConstants

Collection of special constants, such as keys and data types, from JSON schema definition.

JsonSchemaDsl

@DslMarker

annotation class JsonSchemaDsl

Marker annotation for the JSON Schema DSL.

NumericConstraints

interface NumericConstraints

Numeric validation keywords.

NumericPropertyBuilder

class NumericPropertyBuilder

Builder for NumericPropertyDefinition.

NumericPropertyDefinition

@Serializable

data class NumericPropertyDefinition(val type: List<String>, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val ref: String? = null, val dynamicRef: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val enum: List<Double>? = null, val multipleOf: Double? = null, val minimum: Double? = null, val exclusiveMinimum: Double? = null, val maximum: Double? = null, val exclusiveMaximum: Double? = null) : ValuePropertyDefinition<Double> , NumericConstraints

Represents a numeric property (integer or number).

ObjectPropertyBuilder

class ObjectPropertyBuilder

Builder for ObjectPropertyDefinition.

ObjectPropertyDefinition

@Serializable

data class ObjectPropertyDefinition(val type: List<String> = OBJECT_TYPE, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val ref: String? = null, val dynamicRef: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val enum: List<JsonObject>? = null, val properties: Map<String, PropertyDefinition>? = null, val patternProperties: Map<String, PropertyDefinition>? = null, val unevaluatedProperties: PropertyDefinition? = null, val propertyNames: PropertyDefinition? = null, val required: List<String>? = null, val dependentRequired: Map<String, List<String>>? = null, val dependentSchemas: Map<String, PropertyDefinition>? = null, val dependencies: Map<String, JsonElement>? = null, val minProperties: Int? = null, val maxProperties: Int? = null, val additionalProperties: AdditionalPropertiesConstraint? = null) : ValuePropertyDefinition<JsonObject> , PropertiesContainer

Represents an object property

OneOfPropertyBuilder

class OneOfPropertyBuilder : PolymorphicOptionsCollector

Builder for OneOfPropertyDefinition.

OneOfPropertyDefinition

@Serializable

data class OneOfPropertyDefinition(val oneOf: List<PropertyDefinition>, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val type: List<String>? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val enum: List<JsonElement>? = null, val minLength: Int? = null, val maxLength: Int? = null, val pattern: String? = null, val format: String? = null, val contentEncoding: String? = null, val contentMediaType: String? = null, val contentSchema: PropertyDefinition? = null, val minimum: Double? = null, val maximum: Double? = null, val exclusiveMinimum: Double? = null, val exclusiveMaximum: Double? = null, val multipleOf: Double? = null, val discriminator: Discriminator? = null, val properties: Map<String, PropertyDefinition>? = null, val patternProperties: Map<String, PropertyDefinition>? = null, val additionalProperties: AdditionalPropertiesConstraint? = null, val unevaluatedProperties: PropertyDefinition? = null, val propertyNames: PropertyDefinition? = null, val required: List<String>? = null, val dependentRequired: Map<String, List<String>>? = null, val dependentSchemas: Map<String, PropertyDefinition>? = null, val minProperties: Int? = null, val maxProperties: Int? = null, val items: PropertyDefinition? = null, val prefixItems: List<PropertyDefinition>? = null, val unevaluatedItems: PropertyDefinition? = null, val contains: PropertyDefinition? = null, val minContains: Int? = null, val maxContains: Int? = null, val minItems: Int? = null, val maxItems: Int? = null, val uniqueItems: Boolean? = null, val ref: String? = null, val dynamicRef: String? = null) : PropertyDefinition, CommonSchemaAttributes, ApplicatorContainer, GeneralConstraints

Represents a oneOf schema composition.

PolymorphicOptionsCollector

interface PolymorphicOptionsCollector

Common interface for builders that collect polymorphic schema options.

PropertiesContainer

interface PropertiesContainer

Interface representing a container for properties in a JSON schema.

PropertyBuilder

class PropertyBuilder

Builder for defining property types and constraints.

PropertyDefinition

@Serializable(with = PropertyDefinitionSerializer::class)

sealed interface PropertyDefinition

Represents a property definition in a JSON Schema.

ReferencePropertyDefinition

@Serializable

data class ReferencePropertyDefinition(val ref: String? = null, val dynamicRef: String? = null, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val type: List<String>? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val enum: List<JsonElement>? = null, val minLength: Int? = null, val maxLength: Int? = null, val pattern: String? = null, val format: String? = null, val contentEncoding: String? = null, val contentMediaType: String? = null, val contentSchema: PropertyDefinition? = null, val minimum: Double? = null, val maximum: Double? = null, val exclusiveMinimum: Double? = null, val exclusiveMaximum: Double? = null, val multipleOf: Double? = null, val properties: Map<String, PropertyDefinition>? = null, val patternProperties: Map<String, PropertyDefinition>? = null, val additionalProperties: AdditionalPropertiesConstraint? = null, val unevaluatedProperties: PropertyDefinition? = null, val propertyNames: PropertyDefinition? = null, val required: List<String>? = null, val dependentRequired: Map<String, List<String>>? = null, val dependentSchemas: Map<String, PropertyDefinition>? = null, val minProperties: Int? = null, val maxProperties: Int? = null, val items: PropertyDefinition? = null, val prefixItems: List<PropertyDefinition>? = null, val unevaluatedItems: PropertyDefinition? = null, val contains: PropertyDefinition? = null, val minContains: Int? = null, val maxContains: Int? = null, val minItems: Int? = null, val maxItems: Int? = null, val uniqueItems: Boolean? = null) : PropertyDefinition, CommonSchemaAttributes, ApplicatorContainer, GeneralConstraints

Represents a reference to another element

StringConstraints

interface StringConstraints

String validation keywords.

StringPropertyBuilder

class StringPropertyBuilder

Builder for StringPropertyDefinition.

StringPropertyDefinition

@Serializable

data class StringPropertyDefinition(val type: List<String> = STRING_TYPE, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val ref: String? = null, val dynamicRef: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val format: String? = null, val contentEncoding: String? = null, val contentMediaType: String? = null, val contentSchema: PropertyDefinition? = null, val enum: List<String>? = null, val minLength: Int? = null, val maxLength: Int? = null, val pattern: String? = null) : ValuePropertyDefinition<String> , StringConstraints

Represents a string property.

ValuePropertyDefinition