generator/io.github.edricchan03.koogle_api.plugin.generator.data.json/JsonSchema

JsonSchema

data class JsonSchema(val type: Set<JsonSchemaType>? = emptySet(), val properties: Map<String, JsonSchema>? = emptyMap(), val patternProperties: Map<String, JsonSchema>? = emptyMap(), val additionalProperties: JsonElement? = null, val items: List<JsonSchema>? = emptyList(), val additionalItems: JsonElement? = null, val required: Boolean? = false, val dependencies: JsonElement? = null, val minimum: Float? = null, val maximum: Float? = null, val exclusiveMinimum: Boolean? = false, val exclusiveMaximum: Boolean? = false, val minItems: Int? = 0, val maxItems: Int? = null, val uniqueItems: Boolean? = false, val pattern: String? = null, val minLength: Int? = 0, val maxLength: Int? = null, val enum: Set<String>? = emptySet(), val default: JsonElement? = null, val title: String? = null, val description: String? = null, val format: JsonSchemaFormat? = null, val divisibleBy: Float? = null, val disallow: Set<JsonSchemaType>? = emptySet(), val extends: List<String>? = emptyList(), val id: String? = null, val metaRef: String? = null, val metaSchema: String? = null)(source)

Data class representing draft 3 of the JSON schema. Note that this data class is not responsible for JSON schema validation.

As per the IETF proposal, all properties are marked as optional.

Constructors

JsonSchema

constructor(type: Set<JsonSchemaType>? = emptySet(), properties: Map<String, JsonSchema>? = emptyMap(), patternProperties: Map<String, JsonSchema>? = emptyMap(), additionalProperties: JsonElement? = null, items: List<JsonSchema>? = emptyList(), additionalItems: JsonElement? = null, required: Boolean? = false, dependencies: JsonElement? = null, minimum: Float? = null, maximum: Float? = null, exclusiveMinimum: Boolean? = false, exclusiveMaximum: Boolean? = false, minItems: Int? = 0, maxItems: Int? = null, uniqueItems: Boolean? = false, pattern: String? = null, minLength: Int? = 0, maxLength: Int? = null, enum: Set<String>? = emptySet(), default: JsonElement? = null, title: String? = null, description: String? = null, format: JsonSchemaFormat? = null, divisibleBy: Float? = null, disallow: Set<JsonSchemaType>? = emptySet(), extends: List<String>? = emptyList(), id: String? = null, metaRef: String? = null, metaSchema: String? = null)

Properties

additionalItems

val additionalItems: JsonElement? = null

This provides a definition for additional items in an array instance when tuple definitions of the items are provided.

additionalItemsAsBoolean

val additionalItemsAsBoolean: Boolean?

Retrieves the additional items as a boolean.

additionalProperties

val additionalProperties: JsonElement? = null

This attribute defines a schema for all properties that are not explicitly defined in an object-type definition.

additionalPropertiesAsBoolean

val additionalPropertiesAsBoolean: Boolean?

Retrieves the additional properties as a boolean.

default

val default: JsonElement? = null

This attribute defines the default value of the instance when the instance is undefined.

dependencies

val dependencies: JsonElement? = null

This attribute is an object that defines the requirements of a property on an instance object.

dependenciesAsString

val dependenciesAsString: String?

Retrieves the dependencies as a string.

description

val description: String? = null

This attribute is a string that provides a full description of the instance property.

disallow

@Serializable(with = JsonSchemaTypeSetWrapSerializer::class)

val disallow: Set<JsonSchemaType>?

This attribute takes the same values as the type attribute, however if the instance matches the type or if this value is an array and the instance matches any type or schema in the array, then this instance is not valid.

divisibleBy

val divisibleBy: Float? = null

This attribute defines what value the number instance must be divisible by with no remainder (the result of the division must be an integer.)

enum

val enum: Set<String>?

This provides an enumeration of all possible values that are valid for the instance property.

exclusiveMaximum

val exclusiveMaximum: Boolean? = false

This attribute indicates if the value of the instance (if the instance is a number) can not equal the number defined by the "maximum" attribute.

exclusiveMinimum

val exclusiveMinimum: Boolean? = false

This attribute indicates if the value of the instance (if the instance is a number) can not equal the number defined by the "minimum" attribute.

extends

@Serializable(with = StringListWrapSerializer::class)

val extends: List<String>?

The value of this property must be another schema which will provide a base schema which the current schema will inherit from.

format

val format: JsonSchemaFormat? = null

This property defines the type of data, content type, or microformat to be expected in the instance property values.

val id: String? = null

This attribute defines the current URI of this schema (this attribute is effectively a "self" link).

items

@Serializable(with = JsonSchemaListWrapSerializer::class)

val items: List<JsonSchema>?

This attribute defines the allowed items in an instance array, and must be a schema or an array of schemas.

maximum

val maximum: Float? = null

This attribute defines the maximum value of the instance property when the type of the instance value is a number.

maxItems

val maxItems: Int? = null

This attribute defines the maximum number of values in an array when the array is the instance value.

maxLength

val maxLength: Int? = null

When the instance value is a string, this defines the maximum length of the string.

metaRef

@SerialName(value = "$ref")

val metaRef: String? = null

This attribute defines a URI of a schema that contains the full representation of this schema.

metaSchema

@SerialName(value = "$schema")

val metaSchema: String? = null

This attribute defines a URI of a JSON Schema that is the schema of the current schema.

minimum

val minimum: Float? = null

This attribute defines the minimum value of the instance property when the type of the instance value is a number.

minItems

val minItems: Int? = 0

This attribute defines the minimum number of values in an array when the array is the instance value.

minLength

val minLength: Int? = 0

When the instance value is a string, this defines the minimum length of the string.

pattern

val pattern: String? = null

When the instance value is a string, this provides a regular expression that a string instance MUST match in order to be valid.

patternProperties

val patternProperties: Map<String, JsonSchema>?

This attribute is an object that defines the schema for a set of property names of an object instance.

properties

val properties: Map<String, JsonSchema>?

This attribute is an object with property definitions that define the valid values of instance object property values.

required

val required: Boolean? = false

This attribute indicates if the instance must have a value, and not be undefined.

title

val title: String? = null

This attribute is a string that provides a short description of the instance property.

type

@Serializable(with = JsonSchemaTypeSetWrapSerializer::class)

val type: Set<JsonSchemaType>?

This attribute defines what the primitive type or the schema of the instance must be in order to validate. This attribute can take one of two forms:

uniqueItems

val uniqueItems: Boolean? = false

This attribute indicates that all items in an array instance MUST be unique (contains no two identical values).

Functions

getAdditionalItemsAsSchema

fun getAdditionalItemsAsSchema(json: Json): Map<String, JsonSchema>?

Retrieves the additional items as an object.

getAdditionalPropertiesAsSchema

fun getAdditionalPropertiesAsSchema(json: Json): Map<String, JsonSchema>?

Retrieves the additional properties as an object.

getDependenciesAsList

fun getDependenciesAsList(json: Json): List<String>?

Retrieves the dependencies as a list of strings. Warning: This function does not check if the value is actually a list.

getDependenciesAsSchema

fun getDependenciesAsSchema(json: Json): JsonSchema?

Retrieves the dependencies as a JsonSchema. Warning: This function does not check if the value is actually an object.