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

ResponseBuilder

class ResponseBuilder(context: OpenApiDslContext) : BodyBuilder, ResponseDsl, Builder<ApiResponse> , Buildable<ApiResponse>

Builder for Response objects, implementing the ResponseDsl.

Constructors

ResponseBuilder

fun ResponseBuilder(context: OpenApiDslContext)

Functions

build

open override fun build(): ApiResponse

Build the object.

content

open infix override 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.

header

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

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

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.