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

Builder

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

Constructors

Builder

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

Properties

description

var description: String?

extensions

var extensions: MutableMap<String, GenericElement>

parameters

val parameters: List<Parameter>

A list of parameters that are applicable for all the operations described under this path.

servers

val servers: List<Server>

A list of servers configured for this path.

summary

var summary: String?

A short summary of the path item

Functions

build

fun build(): PathItem

delete

fun delete(configure: Operation.Builder.() -> Unit)

Sets the DELETE operation for this path item with the Operation DSL.

get

fun get(configure: Operation.Builder.() -> Unit)

Sets the GET operation for this path item with the Operation DSL.

head

fun head(configure: Operation.Builder.() -> Unit)

Sets the HEAD operation for this path item with the Operation DSL.

options

fun options(configure: Operation.Builder.() -> Unit)

Sets the OPTIONS operation for this path item with the Operation DSL.

parameters

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

Adds parameters using the Parameters DSL.

patch

fun patch(configure: Operation.Builder.() -> Unit)

Sets the PATCH operation for this path item with the Operation DSL.

post

fun post(configure: Operation.Builder.() -> Unit)

Sets the POST operation for this path item with the Operation DSL.

put

fun put(configure: Operation.Builder.() -> Unit)

Sets the PUT operation for this path item with the Operation DSL.

servers

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

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

trace

fun trace(configure: Operation.Builder.() -> Unit)

Sets the TRACE operation for this path item with the Operation DSL.