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

GoogleJsonSchema

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)(source)

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

Constructors

GoogleJsonSchema

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

Types

data class Annotations(val required: List<String>? = null)

data class Variant(val map: List<GoogleJsonSchema.Variant.Map>? = null, val discriminant: String? = null)

Properties

additionalProperties

val additionalProperties: GoogleJsonSchema? = null

If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.

val annotations: GoogleJsonSchema.Annotations? = null

Additional information about this property.

val default: String? = null

The default value of this property (if one exists).

val description: String? = null

A description of this object.

val enum: List<String>? = null

Values this parameter may take (if it is an enum).

enumDescriptions

val enumDescriptions: List<String>? = null

The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.

val enumsAsPairs: List<Pair<String, String?>>?

Gets the list of enums and their descriptions as a list of Pairs.

val format: String? = null

An additional regular expression or key that helps constrain the value.

val id: String? = null

Unique identifier for this schema.

val items: GoogleJsonSchema? = null

If this is a schema for an array, this property is the schema for each element in the array.

val location: String? = null

Whether this parameter goes in the query or the path for REST requests.

val maximum: String? = null

The maximum value of this parameter.

@SerialName(value = "$ref")

val metaRef: String? = null

A reference to another schema. The value of this property is the "id" of another schema.

val minimum: String? = null

The minimum value of this parameter.

val pattern: String? = null

The regular expression this parameter must conform to. Uses Java 6 regex format

val properties: Map<String, GoogleJsonSchema>? = null

If this is a schema for an object, list the schema for each property of this object.

val readOnly: Boolean? = null

The value is read-only, generated by the service. The value cannot be modified by the client.

val repeated: Boolean? = null

Whether this parameter may appear multiple times.

val required: Boolean? = null

Whether the parameter is required.

requiredAnnotations

val requiredAnnotations: List<String>?

Gets the required annotations.

val type: JsonSchemaType? = null

The value type for this schema.

val variant: GoogleJsonSchema.Variant? = null

In a variant data type, the value of one property is used to determine how to interpret the entire entity.