kotlinx-schema-json/kotlinx.schema.json/OneOfPropertyDefinition

OneOfPropertyDefinition

@Serializable
data class OneOfPropertyDefinition(val oneOf: List<PropertyDefinition>, val id: String? = null, val anchor: String? = null, val dynamicAnchor: 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 type: List<String>? = 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 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<JsonElement>? = null, val minLength: Int? = null, val maxLength: Int? = null, val pattern: String? = null, val format: String? = null, val contentEncoding: String? = null, val contentMediaType: String? = null, val contentSchema: PropertyDefinition? = null, val minimum: Double? = null, val maximum: Double? = null, val exclusiveMinimum: Double? = null, val exclusiveMaximum: Double? = null, val multipleOf: Double? = null, val discriminator: Discriminator? = null, val properties: Map<String, PropertyDefinition>? = null, val patternProperties: Map<String, PropertyDefinition>? = null, val additionalProperties: AdditionalPropertiesConstraint? = 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 minProperties: Int? = null, val maxProperties: Int? = 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, val ref: String? = null, val dynamicRef: String? = null) : PropertyDefinition, CommonSchemaAttributes, ApplicatorContainer, GeneralConstraints(source)

Represents a oneOf schema composition.

Validates that the instance matches exactly one of the provided schemas. Commonly used for polymorphic types with mutually exclusive alternatives.

See also

Constructors

Link copied to clipboard
constructor(oneOf: List<PropertyDefinition>, id: String? = null, anchor: String? = null, dynamicAnchor: String? = null, comment: String? = null, title: String? = null, description: String? = null, nullable: Boolean? = null, default: JsonElement? = null, constValue: JsonElement? = null, type: List<String>? = null, defs: Map<String, PropertyDefinition>? = null, readOnly: Boolean? = null, writeOnly: Boolean? = null, deprecated: Boolean? = null, examples: List<JsonElement>? = null, anyOf: List<PropertyDefinition>? = null, allOf: List<PropertyDefinition>? = null, not: PropertyDefinition? = null, ifSchema: PropertyDefinition? = null, thenSchema: PropertyDefinition? = null, elseSchema: PropertyDefinition? = null, enum: List<JsonElement>? = null, minLength: Int? = null, maxLength: Int? = null, pattern: String? = null, format: String? = null, contentEncoding: String? = null, contentMediaType: String? = null, contentSchema: PropertyDefinition? = null, minimum: Double? = null, maximum: Double? = null, exclusiveMinimum: Double? = null, exclusiveMaximum: Double? = null, multipleOf: Double? = null, discriminator: Discriminator? = null, properties: Map<String, PropertyDefinition>? = null, patternProperties: Map<String, PropertyDefinition>? = null, additionalProperties: AdditionalPropertiesConstraint? = null, unevaluatedProperties: PropertyDefinition? = null, propertyNames: PropertyDefinition? = null, required: List<String>? = null, dependentRequired: Map<String, List<String>>? = null, dependentSchemas: Map<String, PropertyDefinition>? = null, minProperties: Int? = null, maxProperties: Int? = 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, ref: String? = null, dynamicRef: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "additionalProperties")
open override val additionalProperties: AdditionalPropertiesConstraint?

Constraint for additional properties in the object.

Link copied to clipboard
open override val allOf: List<PropertyDefinition>?
Link copied to clipboard
@SerialName(value = "$anchor")
open override val anchor: String?
Link copied to clipboard
open override val anyOf: List<PropertyDefinition>?
Link copied to clipboard
@SerialName(value = "$comment")
open override val comment: String?
Link copied to clipboard
@SerialName(value = "const")
open override val constValue: JsonElement?
Link copied to clipboard
open override val contains: PropertyDefinition?

Schema that at least one array item must match.

Link copied to clipboard
open override val contentEncoding: String?
Link copied to clipboard
open override val contentMediaType: String?
Link copied to clipboard
open override val contentSchema: PropertyDefinition?
Link copied to clipboard
open override val default: JsonElement?
Link copied to clipboard
@SerialName(value = "$defs")
open override val defs: Map<String, PropertyDefinition>?
Link copied to clipboard
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.

Link copied to clipboard
open override val dependentSchemas: Map<String, PropertyDefinition>?

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

Link copied to clipboard
open override val deprecated: Boolean?
Link copied to clipboard
open override val description: String?

Optional description of the property

Link copied to clipboard
val discriminator: Discriminator?

Optional discriminator to efficiently determine which schema applies

Link copied to clipboard
@SerialName(value = "$dynamicAnchor")
open override val dynamicAnchor: String?
Link copied to clipboard
@SerialName(value = "$dynamicRef")
open override val dynamicRef: String?
Link copied to clipboard
@SerialName(value = "else")
open override val elseSchema: PropertyDefinition?
Link copied to clipboard
Link copied to clipboard
open override val examples: List<JsonElement>?
Link copied to clipboard
open override val exclusiveMaximum: Double?
Link copied to clipboard
open override val exclusiveMinimum: Double?
Link copied to clipboard
open override val format: String?
Link copied to clipboard
@SerialName(value = "$id")
open override val id: String?
Link copied to clipboard
@SerialName(value = "if")
open override val ifSchema: PropertyDefinition?
Link copied to clipboard
open override val items: PropertyDefinition?

Schema for array items.

Link copied to clipboard
@Serializable(with = NumberToNullableIntSerializer::class)
open override val maxContains: Int?

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

Link copied to clipboard
open override val maximum: Double?
Link copied to clipboard
@Serializable(with = NumberToNullableIntSerializer::class)
open override val maxItems: Int?

Maximum number of items allowed in the array.

Link copied to clipboard
Link copied to clipboard
@Serializable(with = NumberToNullableIntSerializer::class)
open override val maxProperties: Int?

Maximum number of properties allowed in the object.

Link copied to clipboard
@Serializable(with = NumberToNullableIntSerializer::class)
open override val minContains: Int?

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

Link copied to clipboard
open override val minimum: Double?
Link copied to clipboard
@Serializable(with = NumberToNullableIntSerializer::class)
open override val minItems: Int?

Minimum number of items allowed in the array.

Link copied to clipboard
Link copied to clipboard
@Serializable(with = NumberToNullableIntSerializer::class)
open override val minProperties: Int?

Minimum number of properties allowed in the object.

Link copied to clipboard
open override val multipleOf: Double?
Link copied to clipboard
open override val not: PropertyDefinition?
Link copied to clipboard
open override val nullable: Boolean?
Link copied to clipboard
open override val oneOf: List<PropertyDefinition>

List of property definitions representing the alternatives. Must contain at least 2 options.

Link copied to clipboard
open override val pattern: String?
Link copied to clipboard
open override val patternProperties: Map<String, PropertyDefinition>?

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

Link copied to clipboard
open override val prefixItems: List<PropertyDefinition>?

Array of schemas for positional items.

Link copied to clipboard
open override val properties: Map<String, PropertyDefinition>?

Map of property definitions.

Link copied to clipboard
open override val propertyNames: PropertyDefinition?

Schema for property names.

Link copied to clipboard
open override val readOnly: Boolean?
Link copied to clipboard
@SerialName(value = "$ref")
open override val ref: String?
Link copied to clipboard
open override val required: List<String>?

List of required property names.

Link copied to clipboard
@SerialName(value = "then")
open override val thenSchema: PropertyDefinition?
Link copied to clipboard
open override val title: String?
Link copied to clipboard
Link copied to clipboard
open override val unevaluatedItems: PropertyDefinition?

Schema for unevaluated array items.

Link copied to clipboard
open override val unevaluatedProperties: PropertyDefinition?

Schema for unevaluated properties.

Link copied to clipboard
open override val uniqueItems: Boolean?

Whether all items in the array must be unique.

Link copied to clipboard
open override val writeOnly: Boolean?

Functions

Link copied to clipboard
open fun allOfProperty(name: String): AllOfPropertyDefinition?

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

Link copied to clipboard
open fun anyOfProperty(name: String): AnyOfPropertyDefinition?

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

Link copied to clipboard
open fun arrayProperty(name: String): ArrayPropertyDefinition?

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

Link copied to clipboard
open fun booleanProperty(name: String): BooleanPropertyDefinition?

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

Link copied to clipboard
open fun booleanSchemaProperty(name: String): BooleanSchemaDefinition?

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

Link copied to clipboard
open fun numericProperty(name: String): NumericPropertyDefinition?

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

Link copied to clipboard
open fun objectProperty(name: String): ObjectPropertyDefinition?

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

Link copied to clipboard
open fun oneOfProperty(name: String): OneOfPropertyDefinition?

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

Link copied to clipboard
open fun referenceProperty(name: String): ReferencePropertyDefinition?

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

Link copied to clipboard
open fun stringProperty(name: String): StringPropertyDefinition?

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

Generated by Dokka
© 2026 Copyright