tegral-openapi-dsl/guru.zoroark.tegral.openapi.dsl/ResponseDsl

ResponseDsl

interface ResponseDsl : BodyDsl

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

Inheritors

ResponseBuilder

Properties

abstract val content: MutableList<Pair<String, Buildable<MediaType>>>

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

abstract var description: String?

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

open val form: ContentType

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

abstract val headers: MutableList<Pair<String, Buildable<Header>>>

Headers this response may return.

open val json: ContentType

ContentType object for application/json

open val plainText: ContentType

ContentType object for text/plain

open val xml: ContentType

ContentType object for application/xml

Functions

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.

abstract infix fun String.header(builder: HeaderBuilder.() -> Unit)

Add a header to this response with the given string as its name.

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.