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

BodyDsl

interface BodyDsl : PredefinedContentTypesDsl

DSL for body-like objects, i.e. objects that contain a "content" property.

Inheritors

BodyBuilder

RequestBodyDsl

ResponseDsl

Functions

content

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.

invoke

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

content

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.

form

open val form: ContentType

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

json

open val json: ContentType

ContentType object for application/json

plainText

open val plainText: ContentType

ContentType object for text/plain

xml

open val xml: ContentType

ContentType object for application/xml