kotlinx-schema-json/kotlinx.schema.json/JsonSchemaDefinition

JsonSchemaDefinition

data class JsonSchemaDefinition(val id: String? = null, val schema: String? = null, val type: String = "object", val properties: Map<String, PropertyDefinition> = emptyMap(), val required: List<String> = emptyList(), val additionalProperties: JsonElement? = null, val description: String? = null, val items: PropertyDefinition? = null, val oneOf: List<PropertyDefinition>? = null, val discriminator: Discriminator? = null, val defs: Map<String, PropertyDefinition>? = null) : PropertiesContainer(source)

Represents a JSON Schema definition.

Author

Konstantin Pavlov

Constructors

JsonSchemaDefinition

constructor(id: String? = null, schema: String? = null, type: String = "object", properties: Map<String, PropertyDefinition> = emptyMap(), required: List<String> = emptyList(), additionalProperties: JsonElement? = null, description: String? = null, items: PropertyDefinition? = null, oneOf: List<PropertyDefinition>? = null, discriminator: Discriminator? = null, defs: Map<String, PropertyDefinition>? = null)

Properties

additionalProperties

val additionalProperties: JsonElement?

Defines whether additional properties are allowed and their schema. Can be:

defs

@SerialName(value = "$defs")

val defs: Map<String, PropertyDefinition>?

Schema definitions for reusable types (JSON Schema $defs).

description

val description: String?

Optional description of the schema.

discriminator

val discriminator: Discriminator?

Optional discriminator for polymorphic schemas.

@SerialName(value = "$id")

val id: String?

JSON Schema $id

items

val items: PropertyDefinition?

oneOf

val oneOf: List<PropertyDefinition>?

List of alternative schemas for polymorphic types.

properties

open override val properties: Map<String, PropertyDefinition>

A map of property definitions.

required

val required: List<String>

List of required property names.

schema

@SerialName(value = "$schema")

val schema: String?

JSON Schema $schema keyword, e.g. https://json-schema.org/draft/2020-12/schema

type

@EncodeDefault

val type: String

The JSON schema type (e.g., "object", "array", "string", etc.).

Functions

allOfProperty

open fun allOfProperty(name: String): AllOfPropertyDefinition?

Retrieves the allOf property definition associated with the specified property name.

anyOfProperty

open fun anyOfProperty(name: String): AnyOfPropertyDefinition?

Retrieves the anyOf property definition associated with the specified property name.

arrayProperty

open fun arrayProperty(name: String): ArrayPropertyDefinition?

Retrieves the array property definition associated with the specified property name.

booleanProperty

open fun booleanProperty(name: String): BooleanPropertyDefinition?

Retrieves the boolean property definition associated with the specified property name.

numericProperty

open fun numericProperty(name: String): NumericPropertyDefinition?

Retrieves the numeric property definition associated with the specified property name.

objectProperty

open fun objectProperty(name: String): ObjectPropertyDefinition?

Retrieves the object property definition associated with the specified property name.

oneOfProperty

open fun oneOfProperty(name: String): OneOfPropertyDefinition?

Retrieves the oneOf property definition associated with the specified property name.

referenceProperty

open fun referenceProperty(name: String): ReferencePropertyDefinition?

Retrieves the reference property definition associated with the specified property name.

stringProperty

open fun stringProperty(name: String): StringPropertyDefinition?

Retrieves the string property definition associated with the specified property name.