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

ResponseConfig

A container for the expected responses of an operation. The container maps an HTTP response code to the expected response. A response code can only have one response object.

Properties

description

var description: String?

A short description of the response

hidden

var hidden: Boolean

Don't include this response in the openapi-spec

statusCode

val statusCode: String

Functions

body

inline fun <T> body(noinline block: SimpleBodyConfig.() -> Unit = {})

fun body(type: TypeDescriptor, block: SimpleBodyConfig.() -> Unit = {})

fun body(type: Schema<*>, block: SimpleBodyConfig.() -> Unit = {})

fun body(type: KType, block: SimpleBodyConfig.() -> Unit = {})

The body returned with this response

header

inline fun <T> header(name: String, noinline block: HeaderConfig.() -> Unit = {})

fun header(name: String, type: TypeDescriptor, block: HeaderConfig.() -> Unit = {})

fun header(name: String, type: Schema<*>, block: HeaderConfig.() -> Unit = {})

fun header(name: String, type: KType, block: HeaderConfig.() -> Unit = {})

Possible headers returned with this response

multipartBody

fun multipartBody(block: MultipartBodyConfig.() -> Unit)

The multipart-body returned with this response