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

Builder

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

Builder for constructing a Parameter instance.

Report a problem

Constructors

Builder

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

Properties

allowEmptyValue

var allowEmptyValue: Boolean?

Allows sending a parameter with an empty value. Deprecated in OpenAPI 3.1, only applies to query parameters.

allowReserved

var allowReserved: Boolean?

Determines if reserved characters are allowed without percent-encoding. Only applies to query parameters.

content

val content: Map<ContentType, MediaType>

Map of media type to MediaType object.

deprecated

var deprecated: Boolean

Marks the parameter as deprecated when true.

description

var description: String?

A brief description of the parameter.

example

var example: GenericElement?

Example of the parameter's potential value.

examples

var examples: MutableMap<String, ReferenceOr<ExampleObject>>

Map of examples for the parameter.

explode

var explode: Boolean?

Specifies whether arrays and objects generate separate parameters for each value.

extensions

val extensions: MutableMap<String, GenericElement>

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

var in: ParameterType?

Location of the parameter: one of "query", "header", "path", or "cookie".

name

var name: String?

The name of the parameter.

required

var required: Boolean

Whether this parameter is mandatory.

schema

var schema: JsonSchema?

The schema defining the parameter type.

style

var style: String?

Describes how the parameter value will be serialized (e.g., "matrix", "label", "form", "simple", "spaceDelimited", "pipeDelimited", "deepObject").

Functions

buildSchema

open override fun buildSchema(type: KType): JsonSchema

Builds a JsonSchema for the given type.

content

fun content(configure: MediaType.Builder.() -> Unit)

Provide a media type definition for the response body.

example

fun example(name: String, example: ExampleObject)

Adds an example for this parameter.

extension

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

Adds a custom vendor-specific extension.

invoke

operator fun ContentType.invoke(configure: MediaType.Builder.() -> Unit = {})

Adds a media type definition for the response body using a ContentType receiver.

jsonSchema

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

Generates a JSON Schema representation for the given type T.