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

Package-level declarations

Data classes used to represent a JSON schema.

See the using Google Discovery API docs for more information.

Types

data class GoogleJsonSchema(val id: String? = null, val description: String? = null, val location: String? = null, val metaRef: String? = null, val type: JsonSchemaType? = null, val format: String? = null, val default: String? = null, val pattern: String? = null, val maximum: String? = null, val minimum: String? = null, val readOnly: Boolean? = null, val required: Boolean? = null, val repeated: Boolean? = null, val enum: List<String>? = null, val enumDescriptions: List<String>? = null, val properties: Map<String, GoogleJsonSchema>? = null, val additionalProperties: GoogleJsonSchema? = null, val items: GoogleJsonSchema? = null, val annotations: GoogleJsonSchema.Annotations? = null, val variant: GoogleJsonSchema.Variant? = null)

Data class representing the JSON schema as returned by the Google Discovery API.

JsonSchema

@Serializable

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)

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

JsonSchemaFormat

@Serializable(with = JsonSchemaFormatSerializer::class)

sealed class JsonSchemaFormat

Class representing the possible values for the format property.

JsonSchemaType

@Serializable

enum JsonSchemaType : Enum<JsonSchemaType>

Enum class representing the possible values for the type property.

Inherited functions

sortKeys

fun JsonObject.sortKeys(): JsonObject

Sorts the keys in this JsonObject. Implementation based on the API generator from the Node.js Google API client.