kotlinx-schema-json/kotlinx.schema.json/ObjectPropertyDefinition

ObjectPropertyDefinition

data class ObjectPropertyDefinition(val type: List<String> = listOf("object"), val description: String? = null, val nullable: Boolean? = null, val properties: Map<String, PropertyDefinition>? = null, val required: List<String>? = null, val additionalProperties: JsonElement? = null, val default: JsonElement? = null) : ValuePropertyDefinition, PropertiesContainer(source)

Represents an object property

Constructors

constructor(type: List<String> = listOf("object"), description: String? = null, nullable: Boolean? = null, properties: Map<String, PropertyDefinition>? = null, required: List<String>? = null, additionalProperties: JsonElement? = null, default: JsonElement? = null)

Properties

additionalProperties

@SerialName(value = "additionalProperties")

val additionalProperties: JsonElement?

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

default

val default: JsonElement?

description

open override val description: String?

Optional description of the property.

nullable

open override val nullable: Boolean?

Whether the property can be null.

properties

open override val properties: Map<String, PropertyDefinition>?

Represents a map of property definitions for an object.

required

val required: List<String>?

type

@Serializable(with = StringOrListSerializer::class)

@EncodeDefault

open override val type: List<String>

The data type of the property.

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.