skema/com.eignex.skema/SchemaDef

SchemaDef

@Serializable

data class SchemaDef<C>(val entries: Map<String, C>)(source)

Pure-data, serializable form of a Schema. The default root field name is entries; for a different name or adjunct fields, define your own Serializable wrapper and override Schema.definition.

Constructors

SchemaDef

constructor(entries: Map<String, C>)

Properties

entries

val entries: Map<String, C>

Entries keyed by name, in declaration order.

names

val names: Set<String>

Set of entry names.

size

val size: Int

Number of entries.

Functions

diff

fun <C> SchemaDef<C>.diff(other: SchemaDef<C>): SchemaDiff<C>

Computes the SchemaDiff from this schema to other.

get

operator fun get(name: String): C

Returns the entry for name, or throws if no such entry exists.

namespaced

@JvmOverloads

fun <C> SchemaDef<C>.namespaced(prefix: String, separator: String = "."): SchemaDef<C>

Prefix every entry name (default separator .).

plus

operator fun <C> SchemaDef<C>.plus(other: SchemaDef<C>): SchemaDef<C>

Combine two schemas into one; throws on any overlapping name.

toJsonSchema

fun SchemaDef<JsonSpec>.toJsonSchema(defs: Map<String, JsonSpec> = emptyMap()): JsonObject

JSON Schema (draft 2020-12) for a schema whose entries are JsonSpecs. All entries are emitted as required; post-process the result if a different required-set is needed. Supply defs to populate the root $defs block; reference them with JsonSpec.Ref("#/${'$'}defs/<name>").

fun <C : Any> SchemaDef<C>.toJsonSchema(defs: Map<String, JsonSpec> = emptyMap(), map: (C) -> JsonObject): JsonObject

JSON Schema (draft 2020-12) for an arbitrary config vocabulary. Supply a mapper that turns each entry's config into a JSON Schema fragment for the value it validates. For mixed hierarchies, call JsonSpec.toJsonSchema inside the lambda for the JsonSpec branches. Supply defs to populate the root $defs block.