Package-level declarations

Types

Link copied to clipboard
@Serializable
@SerialName(value = "array")
data class ArrayProperty(val title: String? = null, val format: String? = null, val description: String? = null, val readOnly: Boolean? = null, val const: JsonPrimitive? = null, val not: Property? = null, val pattern: Regex? = null, val items: Property? = null, val prefixItems: List<ObjectProperty>? = null, val uniqueItems: Boolean = false, val contains: List<Property>? = null) : Property

A property which configure a field with an array value.

Link copied to clipboard
@Serializable
@SerialName(value = "boolean")
data class BooleanProperty(val title: String? = null, val format: String? = null, val description: String? = null, val readOnly: Boolean? = null, val const: JsonPrimitive? = null, val not: Property? = null, val pattern: Regex? = null) : Property

A property which configure a field with a boolean value.

Link copied to clipboard
@Serializable
@SerialName(value = "number")
data class NumberProperty(val title: String? = null, val format: String? = null, val description: String? = null, val readOnly: Boolean? = null, val const: JsonPrimitive? = null, val not: Property? = null, val pattern: Regex? = null, val maximum: Int? = null, val minimum: Int? = null, val default: Int? = null) : Property

A property which configure a field with a number value.

Link copied to clipboard
@Serializable
@SerialName(value = "object")
@ObjCName(name = "Schema")
data class ObjectProperty(val properties: ImmutableMap<String, Property>, val required: ImmutableList<String> = persistentListOf(), val anyOf: ImmutableList<ObjectProperty>? = null, val title: String? = null, val format: String? = null, val description: String? = null, val readOnly: Boolean? = null, val const: JsonPrimitive? = null, val not: Property? = null, val pattern: Regex? = null) : Property

A property which configure a field with an object value.

Link copied to clipboard
@Serializable
sealed class Property

Common base sealed class for any property element.

Link copied to clipboard

Alias of ObjectProperty for any schema element.

Link copied to clipboard
@Serializable
@SerialName(value = "string")
data class StringProperty(val title: String? = null, val format: String? = null, val description: String? = null, val readOnly: Boolean? = null, val const: JsonPrimitive? = null, val not: Property? = null, val pattern: Regex? = null, val minLength: Int? = null, val maxLength: Int? = null, val enum: ImmutableList<String>? = null, val oneOf: ImmutableList<Property>? = null) : Property

A property which configure a field with a string value.