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(source)

Represents an object property

Constructors

ObjectPropertyDefinition

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:

val default: JsonElement?

open override val description: String?

Optional description of the property.

open override val nullable: Boolean?

Whether the property can be null.

val properties: Map<String, PropertyDefinition>?

val required: List<String>?

@Serializable(with = StringOrListSerializer::class)

open override val type: List<String>

The data type of the property.