ktor-openapi-schema/io.ktor.openapi/Responses/Builder

Builder

class Builder(schemaInference: JsonSchemaInference, defaultContentTypes: List<ContentType>)(source)

Builder for collecting operation Responses keyed by status code.

Report a problem

Constructors

constructor(schemaInference: JsonSchemaInference, defaultContentTypes: List<ContentType>)

Properties

var default: Response.Builder?

val extensions: Map<String, GenericElement>

Map of extension properties provided

val responses: Map<Int, Response>

Map of HTTP status code (or "default") to a response definition.

Functions

fun default(configure: Response.Builder.() -> Unit)

Adds the catch-all "default" response.

operator fun HttpStatusCode.invoke(configure: Response.Builder.() -> Unit = {})

Shorthand to add a response using this HttpStatusCode as the key.

fun response(statusCode: Int, configure: Response.Builder.() -> Unit)

Adds a response for the given HTTP statusCode.