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

OperationBuilder

class OperationBuilder(context: OpenApiDslContext) : OperationDsl, Buildable<Operation>

Builder for OperationDsl

Constructors

OperationBuilder

constructor(context: OpenApiDslContext)

Properties

deprecated

open override var deprecated: Boolean?

If true, declares this operation to be deprecated (false by default).

description

open override var description: String?

A verbose explanation of the operation behavior. CommonMark syntax may be used for rich text representation.

externalDocsDescription

open override var externalDocsDescription: String?

A description of the additional external documentation for this operation. CommonMark syntax may be used for rich text representation.

externalDocsUrl

open override var externalDocsUrl: String?

A URL that points to additional external documentation for this operation. Must be a valid URL.

operationId

open override var operationId: String?

A string used to identify the operation, unique among all operations described in the API.

parameters

open override val parameters: MutableList<Buildable<Parameter>>

Parameters that are applicable for this operation.

requestBody

open override var requestBody: RequestBodyBuilder?

The request body applicable for this operation.

responses

open override val responses: MutableMap<Int, Buildable<ApiResponse>>

The list of possible responses as they are returned from executing this operation.

securityRequirements

open override val securityRequirements: MutableList<SecurityRequirement>

A declaration of which security mechanisms can be used for this operation.

summary

open override var summary: String?

A short summary of what the operation does.

Functions

body

open override fun body(builder: RequestBodyDsl.() -> Unit)

Defines the request body for this operation.

build

open override fun build(): Operation

cookieParameter

open infix override fun String.cookieParameter(builder: ParameterDsl.() -> Unit)

Creates a cookie parameter, with the given string as the name of the cookie.

headerParameter

open infix override fun String.headerParameter(builder: ParameterDsl.() -> Unit)

Creates a header parameter, with the given string as the name of the header.

pathParameter

open infix override fun String.pathParameter(builder: ParameterDsl.() -> Unit)

Creates a path parameter, with the given string as the name of the corresponding path segment.

queryParameter

open infix override fun String.queryParameter(builder: ParameterDsl.() -> Unit)

Creates a query parameter, with the given string as the name of the query parameter key.

response

open infix override fun Int.response(builder: ResponseDsl.() -> Unit)

Creates a response for the given response code (passed as an integer value).

security

open override fun security(key: String)

Adds a security requirement object to this operation with the given key.

open override fun security(key: String, vararg scopes: String)

Adds a security requirement object to this operation with the given key and scopes.