ktor-openapi-schema/io.ktor.openapi/JsonType

JsonType

@Serializable(with = JsonSchema.SchemaType.JsonTypeSerializer::class)

enum JsonType : JsonSchema.SchemaType, Enum<JsonType> (source)

Represents the base data types defined in the JSON Schema specification.

These types are used to constrain the values of properties within a JsonSchema.

Report a problem

Entries

An ordered list of instances.

An unordered set of properties.

Any numeric value, including integers and floating-point numbers.

A true or false value.

A numeric value with no fractional part.

A null value.

A sequence of characters.

Properties

val entries: EnumEntries<JsonType>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

expect val name: String

expect val ordinal: Int

Functions

fun JsonType.orNullable(isNullable: Boolean): JsonSchema.SchemaType

fun valueOf(value: String): JsonType

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<JsonType>

Returns an array containing the constants of this enum type, in the order they're declared.