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

Builder

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

DSL builder for assembling a list of Parameters used by an operation.

Report a problem

Constructors

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

Properties

val parameters: List<Parameter>

The collected list of parameters.

Functions

fun cookie(name: String, configure: Parameter.Builder.() -> Unit = {})

Adds a cookie parameter with the given name.

fun header(name: String, configure: Parameter.Builder.() -> Unit = {})

Adds a header parameter with the given name.

fun ~~parameter~~(name: String, configure: Parameter.Builder.() -> Unit)

Adds a generic Parameter via the provided configure block.

fun path(name: String, configure: Parameter.Builder.() -> Unit = {})

Adds a required path parameter with the given name.

fun query(name: String, configure: Parameter.Builder.() -> Unit = {})

Adds a query parameter with the given name.