ResponseDsl

interface ResponseDsl : BodyDsl

DSL for https://spec.openapis.org/oas/v3.1.0#response-object.

Functions

Link copied to clipboard
abstract infix fun String.content(builder: MediaTypeBuilder.() -> Unit)

Creates a content entry for this content type (the string receiver) and body (the builder configured by the lambda). See MediaTypeDsl for more information on what you can do in the lambda.

Link copied to clipboard
open operator fun ContentType.invoke(builder: MediaTypeBuilder.() -> Unit)

Creates a content entry for this content type and body. See MediaTypeDsl for more information on what you can do in the lambda.

open operator fun MultiContentType.invoke(builder: MediaTypeBuilder.() -> Unit)

Creates content entries for each of the provided content types with the same body. See MediaTypeDsl for more information on what you can do in the lambda.

Properties

Link copied to clipboard
abstract val content: MutableList<Pair<String, Builder<MediaType>>>

A "map" containing descriptions of potential payloads. The key is a media type or media type range and teh value describes it.

Link copied to clipboard
abstract var description: String?

A description of the response. CommonMark syntax may be used for rich text representation.

Link copied to clipboard
open val form: ContentType

ContentType object for application/x-www-form-urlencoded

Link copied to clipboard
open val json: ContentType

ContentType object for application/json

Link copied to clipboard
open val plainText: ContentType

ContentType object for text/plain

Link copied to clipboard
open val xml: ContentType

ContentType object for application/xml

Inheritors

Link copied to clipboard