kotlinx-schema-json/kotlinx.schema.json/JsonSchema

JsonSchema

data class JsonSchema(val name: String, val strict: Boolean = false, val description: String? = null, val schema: JsonSchemaDefinition)(source)

Represents a JSON Schema definition

Author

Konstantin Pavlov

Constructors

constructor(name: String, strict: Boolean = false, description: String? = null, schema: JsonSchemaDefinition)

Properties

val description: String?

val name: String

The name of the schema.

val schema: JsonSchemaDefinition

The actual JSON schema definition.

val strict: Boolean

Whether to enable strict schema adherence.

Functions

encodeToJsonObject

fun JsonSchema.encodeToJsonObject(json: Json = Json): JsonObject

Encodes the given JsonSchema instance into a JsonObject representation.

fun JsonSchema.encodeToString(json: Json = Json): String

Encodes the JsonSchema instance into its JSON string representation.