ktor-openapi-schema/io.ktor.openapi/Operation/Builder

Builder

class Builder(schemaInference: JsonSchemaInference, defaultContentTypes: List<ContentType>) : JsonSchemaInference(source)

Builder for OpenAPI Operation object

Report a problem

Constructors

Builder

constructor(schemaInference: JsonSchemaInference, defaultContentTypes: List<ContentType>)

Properties

callbacks

val callbacks: Map<String, ReferenceOr<Callback>>

Callback definitions for this operation, if any.

deprecated

var deprecated: Boolean?

Marks the operation as deprecated when true.

description

var description: String?

A verbose explanation of the operation behavior.

extensions

var extensions: MutableMap<String, GenericElement>

Specification-extensions for this operation (keys must start with x-).

externalDocs

var externalDocs: ExternalDocs?

A URL to additional external documentation for this operation.

operationId

var operationId: String?

Unique string used to identify the operation.

parameters

val parameters: List<Parameter>

Collected parameter definitions for this operation.

requestBody

var requestBody: RequestBody?

Request body definition for this operation, if any.

responses

val responses: Responses?

Collected response definitions keyed by HTTP status code.

securityRequirements

val securityRequirements: List<Map<String, List<String>>>

Declared security requirements for this operation.

servers

val servers: List<Server>

Collected server definitions specific to this operation.

summary

var summary: String?

A short summary of what the operation does.

Functions

buildSchema

open override fun buildSchema(type: KType): JsonSchema

Builds a JsonSchema for the given type.

callback

fun callback(key: String, value: Callback)

Adds a callback definition for this operation using the Callback DSL.

extension

inline fun <T : Any> extension(name: String, value: T)

Adds a extension to this operation.

jsonSchema

inline fun <T : Any> JsonSchemaInference.jsonSchema(): JsonSchema

Generates a JSON Schema representation for the given type T.

parameters

fun parameters(configure: Parameters.Builder.() -> Unit)

Adds operation parameters using the Parameters DSL.

requestBody

fun requestBody(configure: RequestBody.Builder.() -> Unit)

Defines a request body for this operation using the RequestBody DSL.

responses

fun responses(configure: Responses.Builder.() -> Unit)

Adds possible responses returned by this operation using the Responses DSL.

security

fun security(configure: Security.Builder.() -> Unit)

Declares security requirements for this operation using the Security DSL.

servers

fun servers(configure: Servers.Builder.() -> Unit)

Adds server definitions specific to this operation using the Servers DSL.

tag

fun tag(tag: String)

Adds a tag to this operation.