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

PathBuilder

class PathBuilder(context: OpenApiDslContext) : PathDsl, Builder<PathItem> , Buildable<PathItem>

Builder for PathDsl

Constructors

PathBuilder

constructor(context: OpenApiDslContext)

Functions

body

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

Defines the request body for this operation.

build

open override fun build(): PathItem

Build the object.

cookieParameter

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

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

delete

open override fun delete(block: OperationDsl.() -> Unit)

A definition of a DELETE operation on this path.

get

open override fun get(block: OperationDsl.() -> Unit)

A definition of a GET operation on this path.

head

open override fun head(block: OperationDsl.() -> Unit)

A definition of a HEAD operation on this path.

headerParameter

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

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

options

open override fun options(block: OperationDsl.() -> Unit)

A definition of an OPTIONS operation on this path.

patch

open override fun patch(block: OperationDsl.() -> Unit)

A definition of a PATCH operation on this path.

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.

post

open override fun post(block: OperationDsl.() -> Unit)

A definition of a POST operation on this path.

put

open override fun put(block: OperationDsl.() -> Unit)

A definition of a PUT operation on this path.

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.

Properties

delete

open override var delete: OperationBuilder?

The currently registered DELETE operation, or null if none was registered yet.

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.

get

open override var get: OperationBuilder?

The currently registered GET operation, or null if none was registered yet.

head

open override var head: OperationBuilder?

The currently registered HEAD operation, or null if none was registered yet.

operationId

open override var operationId: String?

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

options

open override var options: OperationBuilder?

The currently registered OPTIONS operation, or null if none was registered yet.

parameters

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

Parameters that are applicable for this operation.

patch

open override var patch: OperationBuilder?

The currently registered PATCH operation, or null if none was registered yet.

post

open override var post: OperationBuilder?

The currently registered POST operation, or null if none was registered yet.

put

open override var put: OperationBuilder?

The currently registered PUT operation, or null if none was registered yet.

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.