skema

skema/com.eignex.skema/JsonSpec/Annotated

Annotated

@Serializable

@SerialName(value = "Annotated")

data class Annotated(val inner: JsonSpec, val title: String? = null, val description: String? = null, val default: JsonElement? = null, val examples: List<JsonElement>? = null, val deprecated: Boolean? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val comment: String? = null) : JsonSpec(source)

Wraps another JsonSpec with JSON Schema annotations. Annotations decorate the inner spec without changing the values it accepts.

Constructors

constructor(inner: JsonSpec, title: String? = null, description: String? = null, default: JsonElement? = null, examples: List<JsonElement>? = null, deprecated: Boolean? = null, readOnly: Boolean? = null, writeOnly: Boolean? = null, comment: String? = null)

Properties

val comment: String?

Non-validating comment, ignored by validators.

val default: JsonElement?

Default value, used by generators and form-renderers.

val deprecated: Boolean?

Marks the value as deprecated.

val description: String?

Longer human-readable explanation.

val examples: List<JsonElement>?

Example values, used by documentation.

val inner: JsonSpec

The spec being annotated.

val readOnly: Boolean?

Marks the value as read-only (e.g., server-assigned).

val title: String?

Short human-readable label.

val writeOnly: Boolean?

Marks the value as write-only (e.g., passwords).

Functions

fun JsonSpec.toJsonSchema(): JsonObject

JSON Schema fragment describing the value this primitive validates.

Annotated

constructor(inner: JsonSpec, title: String? = null, description: String? = null, default: JsonElement? = null, examples: List<JsonElement>? = null, deprecated: Boolean? = null, readOnly: Boolean? = null, writeOnly: Boolean? = null, comment: String? = null)(source)

comment

val comment: String?(source)

Non-validating comment, ignored by validators.

default

val default: JsonElement?(source)

Default value, used by generators and form-renderers.

deprecated

val deprecated: Boolean?(source)

Marks the value as deprecated.

description

val description: String?(source)

Longer human-readable explanation.

examples

val examples: List<JsonElement>?(source)

Example values, used by documentation.

inner

val inner: JsonSpec(source)

The spec being annotated.

readOnly

val readOnly: Boolean?(source)

Marks the value as read-only (e.g., server-assigned).

title

val title: String?(source)

Short human-readable label.

writeOnly

val writeOnly: Boolean?(source)

Marks the value as write-only (e.g., passwords).