ktor-openapi/io.github.smiley4.ktoropenapi.config.descriptors

Package-level declarations

Types

AnyOfTypeDescriptor

class AnyOfTypeDescriptor(val types: List<TypeDescriptor>) : TypeDescriptor

Describes an object matching any of the given types.

ArrayTypeDescriptor

class ArrayTypeDescriptor(val type: TypeDescriptor) : TypeDescriptor

Describes an array of types.

EmptyTypeDescriptor

class EmptyTypeDescriptor : TypeDescriptor

Describes an empty type/schema.

ExampleDescriptor

sealed class ExampleDescriptor

Identifier and description of an example

KTypeDescriptor

class KTypeDescriptor(val type: KType) : TypeDescriptor

Describes a type from a kotlin KType

RefExampleDescriptor

class RefExampleDescriptor(val name: String, val refName: String) : ExampleDescriptor

Describes a reference to a shared example placed in the components section

RefTypeDescriptor

class RefTypeDescriptor(val schemaId: String) : TypeDescriptor

Describes a reference to a schema in the component section.

SerialTypeDescriptor

class SerialTypeDescriptor(val descriptor: SerialDescriptor) : TypeDescriptor

Describes a type from a kotlinx-serialization SerialDescriptor

SwaggerExampleDescriptor

class SwaggerExampleDescriptor(val name: String, val example: Example) : ExampleDescriptor

Describes an example as a swagger Example-object

SwaggerTypeDescriptor

class SwaggerTypeDescriptor(val schema: Schema<*>) : TypeDescriptor

Describes a type from a swagger Schema

TypeDescriptor

sealed interface TypeDescriptor

Describes and identifies types and schemas.

ValueExampleDescriptor

class ValueExampleDescriptor(val name: String, val value: Any?, val summary: String? = null, val description: String? = null) : ExampleDescriptor

Describes an example as an object.

Functions

anyOf

fun anyOf(vararg types: TypeDescriptor): AnyOfTypeDescriptor

fun anyOf(vararg types: Schema<*>): AnyOfTypeDescriptor

fun anyOf(vararg types: KType): AnyOfTypeDescriptor

fun anyOf(types: Collection<TypeDescriptor>): AnyOfTypeDescriptor

@JvmName(name = "anyOfSwagger")

fun anyOf(types: Collection<Schema<*>>): AnyOfTypeDescriptor

@JvmName(name = "anyOfKType")

fun anyOf(types: Collection<KType>): AnyOfTypeDescriptor

Describe any of the given types.

array

inline fun <T> array(): ArrayTypeDescriptor

fun array(type: TypeDescriptor): ArrayTypeDescriptor

fun array(type: Schema<*>): ArrayTypeDescriptor

fun array(type: KType): ArrayTypeDescriptor

Describe an array with the given item type.

empty

fun empty(): EmptyTypeDescriptor

Describe an empty / "any" schema.

ref

fun ref(schemaId: String): RefTypeDescriptor

Describe a schema referenced by the given id.

type

inline fun <T> type(): KTypeDescriptor

Create a schema describing the given type parameter.