kotlinx-schema-json/kotlinx.schema.json/ArrayPropertyDefinition

ArrayPropertyDefinition

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

Represents an array property

Constructors

ArrayPropertyDefinition

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

Properties

open override val allOf: List<PropertyDefinition>?

@SerialName(value = "$anchor")

open override val anchor: String?

open override val anyOf: List<PropertyDefinition>?

@SerialName(value = "$comment")

open override val comment: String?

@SerialName(value = "const")

open override val constValue: JsonElement?

Const value as JsonElement (spec-compliant storage). Can be any JSON value per JSON Schema 2020-12 spec.

open override val contains: PropertyDefinition?

Schema that at least one array item must match.

open override val default: JsonElement?

Default value as JsonElement (spec-compliant storage). Can be any JSON value per JSON Schema 2020-12 spec.

@SerialName(value = "$defs")

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

open override val deprecated: Boolean?

open override val description: String?

@SerialName(value = "$dynamicAnchor")

open override val dynamicAnchor: String?

@SerialName(value = "$dynamicRef")

open override val dynamicRef: String?

@SerialName(value = "else")

open override val elseSchema: PropertyDefinition?

@Serializable(with = ArrayEnumSerializer::class)

val enum: List<JsonArray>?

open override val examples: List<JsonElement>?

@SerialName(value = "$id")

open override val id: String?

@SerialName(value = "if")

open override val ifSchema: PropertyDefinition?

open override val items: PropertyDefinition?

Schema for array items.

@Serializable(with = NumberToNullableIntSerializer::class)

open override val maxContains: Int?

Maximum number of items that can match the "contains" schema.

@Serializable(with = NumberToNullableIntSerializer::class)

open override val maxItems: Int?

Maximum number of items allowed in the array.

@Serializable(with = NumberToNullableIntSerializer::class)

open override val minContains: Int?

Minimum number of items that must match the "contains" schema.

@Serializable(with = NumberToNullableIntSerializer::class)

open override val minItems: Int?

Minimum number of items allowed in the array.

open override val not: PropertyDefinition?

open override val nullable: Boolean?

Whether the property can be null.

open override val oneOf: List<PropertyDefinition>?

open override val prefixItems: List<PropertyDefinition>?

Array of schemas for positional items.

open override val readOnly: Boolean?

@SerialName(value = "$ref")

open override val ref: String?

@SerialName(value = "then")

open override val thenSchema: PropertyDefinition?

open override val title: String?

@Serializable(with = StringOrListSerializer::class)

open override val type: List<String>

The data type of the property.

unevaluatedItems

open override val unevaluatedItems: PropertyDefinition?

Schema for unevaluated array items.

open override val uniqueItems: Boolean?

Whether all items in the array must be unique.

open override val writeOnly: Boolean?

Functions

open override fun getTypedConst(): JsonArray?

Returns the const value as a JsonArray, or null if not set or not an array.

getTypedDefault

open override fun getTypedDefault(): JsonArray?

Returns the default value as a JsonArray, or null if not set or not an array.