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

ObjectPropertyDefinition

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

Represents an object property

Constructors

ObjectPropertyDefinition

constructor(type: List<String> = OBJECT_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<JsonObject>? = null, properties: Map<String, PropertyDefinition>? = null, patternProperties: Map<String, PropertyDefinition>? = null, unevaluatedProperties: PropertyDefinition? = null, propertyNames: PropertyDefinition? = null, required: List<String>? = null, dependentRequired: Map<String, List<String>>? = null, dependentSchemas: Map<String, PropertyDefinition>? = null, dependencies: Map<String, JsonElement>? = null, minProperties: Int? = null, maxProperties: Int? = null, additionalProperties: AdditionalPropertiesConstraint? = null)

Properties

additionalProperties

@SerialName(value = "additionalProperties")

open override val additionalProperties: AdditionalPropertiesConstraint?

Constraint for additional properties in the object.

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 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>?

val dependencies: Map<String, JsonElement>?

dependentRequired

open override val dependentRequired: Map<String, List<String>>?

A map of property names to lists of other property names that are required if the given property is present.

dependentSchemas

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

A map of property names to schemas that must be satisfied if the given property is present.

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 = ObjectEnumSerializer::class)

val enum: List<JsonObject>?

open override val examples: List<JsonElement>?

@SerialName(value = "$id")

open override val id: String?

@SerialName(value = "if")

open override val ifSchema: PropertyDefinition?

@Serializable(with = NumberToNullableIntSerializer::class)

open override val maxProperties: Int?

Maximum number of properties allowed in the object.

@Serializable(with = NumberToNullableIntSerializer::class)

open override val minProperties: Int?

Minimum number of properties allowed in the object.

open override val not: PropertyDefinition?

open override val nullable: Boolean?

Whether the property can be null.

open override val oneOf: List<PropertyDefinition>?

patternProperties

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

Map of property definitions for properties matching a regular expression pattern.

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

Map of property definitions.

open override val propertyNames: PropertyDefinition?

Schema for property names.

open override val readOnly: Boolean?

@SerialName(value = "$ref")

open override val ref: String?

open override val required: List<String>?

List of required property names.

@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.

unevaluatedProperties

open override val unevaluatedProperties: PropertyDefinition?

Schema for unevaluated properties.

open override val writeOnly: Boolean?

Functions

open fun allOfProperty(name: String): AllOfPropertyDefinition?

Returns the allOf property definition for name, or null if not found or not an allOf.

open fun anyOfProperty(name: String): AnyOfPropertyDefinition?

Returns the anyOf property definition for name, or null if not found or not an anyOf.

open fun arrayProperty(name: String): ArrayPropertyDefinition?

Returns the array property definition for name, or null if not found or not an array property.

booleanProperty

open fun booleanProperty(name: String): BooleanPropertyDefinition?

Returns the boolean property definition for name, or null if not found or not a boolean property.

booleanSchemaProperty

open fun booleanSchemaProperty(name: String): BooleanSchemaDefinition?

Returns the boolean schema definition for name, or null if not found or not a boolean schema.

open override fun getTypedConst(): JsonObject?

Returns the const value as a JsonObject, or null if not set or not an object.

getTypedDefault

open override fun getTypedDefault(): JsonObject?

Returns the default value as a JsonObject, or null if not set or not an object.

numericProperty

open fun numericProperty(name: String): NumericPropertyDefinition?

Returns the numeric property definition for name, or null if not found or not a numeric property.

open fun objectProperty(name: String): ObjectPropertyDefinition?

Returns the object property definition for name, or null if not found or not an object property.

open fun oneOfProperty(name: String): OneOfPropertyDefinition?

Returns the oneOf property definition for name, or null if not found or not a oneOf.

referenceProperty

open fun referenceProperty(name: String): ReferencePropertyDefinition?

Returns the reference property definition for name, or null if not found or not a reference.

open fun stringProperty(name: String): StringPropertyDefinition?

Returns the string property definition for name, or null if not found or not a string property.