ObjectBuilder

Declares the properties of one object schema.

Functions

fun any(name: String, description: String? = null, optional: Boolean = false)

A value of any JSON type — for keys whose type legitimately varies (e.g. a setting's value).

fun array(name: String, description: String? = null, nullable: Boolean = false, optional: Boolean = false, block: OutputSchema.ObjectBuilder.() -> Unit)

An array of objects, each declared by block.

fun arrayOf(name: String, items: Map<String, Any>, description: String? = null, nullable: Boolean = false, optional: Boolean = false)

An array whose items match items (e.g. OutputSchema.string).

fun boolean(name: String, description: String? = null, nullable: Boolean = false, optional: Boolean = false)

fun integer(name: String, description: String? = null, nullable: Boolean = false, optional: Boolean = false)

fun map(name: String, description: String? = null, nullable: Boolean = false, optional: Boolean = false)

A free-form object (arbitrary keys), e.g. a settings dump or extras bundle.

fun number(name: String, description: String? = null, nullable: Boolean = false, optional: Boolean = false)

fun obj(name: String, description: String? = null, nullable: Boolean = false, optional: Boolean = false, block: OutputSchema.ObjectBuilder.() -> Unit)

A nested object whose own properties are declared by block.

fun string(name: String, description: String? = null, nullable: Boolean = false, optional: Boolean = false)