skema

skema/com.eignex.skema/JsonSpec/Object

Object

@Serializable

@SerialName(value = "Object")

data class Object(val properties: Map<String, JsonSpec> = emptyMap(), val required: List<String> = emptyList(), val additionalPropertiesAllowed: Boolean? = null, val additionalPropertiesSpec: JsonSpec? = null, val minProperties: Int? = null, val maxProperties: Int? = null) : JsonSpec(source)

Object with named properties. additionalPropertiesAllowed gates extras; set additionalPropertiesSpec to constrain extras to a schema instead of a boolean. If both are set, the spec wins.

Constructors

constructor(properties: Map<String, JsonSpec> = emptyMap(), required: List<String> = emptyList(), additionalPropertiesAllowed: Boolean? = null, additionalPropertiesSpec: JsonSpec? = null, minProperties: Int? = null, maxProperties: Int? = null)

Properties

additionalPropertiesAllowed

val additionalPropertiesAllowed: Boolean?

Whether properties not listed in properties are allowed. Default true (per JSON Schema).

additionalPropertiesSpec

val additionalPropertiesSpec: JsonSpec?

Spec that all additional (unlisted) properties must match.

val maxProperties: Int?

Maximum number of properties.

val minProperties: Int?

Minimum number of properties.

val properties: Map<String, JsonSpec>

Named properties and their specs.

val required: List<String>

Property names that must be present.

Functions

fun JsonSpec.toJsonSchema(): JsonObject

JSON Schema fragment describing the value this primitive validates.

Object

constructor(properties: Map<String, JsonSpec> = emptyMap(), required: List<String> = emptyList(), additionalPropertiesAllowed: Boolean? = null, additionalPropertiesSpec: JsonSpec? = null, minProperties: Int? = null, maxProperties: Int? = null)(source)

additionalPropertiesAllowed

val additionalPropertiesAllowed: Boolean?(source)

Whether properties not listed in properties are allowed. Default true (per JSON Schema).

additionalPropertiesSpec

val additionalPropertiesSpec: JsonSpec?(source)

Spec that all additional (unlisted) properties must match.

maxProperties

val maxProperties: Int?(source)

Maximum number of properties.

minProperties

val minProperties: Int?(source)

Minimum number of properties.

properties

val properties: Map<String, JsonSpec>(source)

Named properties and their specs.

required

val required: List<String>(source)

Property names that must be present.