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

Parameter

@Serializable(with = Parameter.Companion.Serializer::class)

data class Parameter(val name: String, val in: ParameterType? = null, val description: String? = null, val required: Boolean = false, val deprecated: Boolean = false, val schema: ReferenceOr<JsonSchema>? = null, val content: Map<@Serializable(with = ContentTypeSerializer::class) ContentType, MediaType>? = null, val style: String? = null, val explode: Boolean? = null, val allowReserved: Boolean? = null, val allowEmptyValue: Boolean? = null, val example: GenericElement? = null, val examples: Map<String, ReferenceOr<ExampleObject>>? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Describes a single operation parameter (path, query, header, or cookie).

Report a problem

Constructors

constructor(name: String, in: ParameterType? = null, description: String? = null, required: Boolean = false, deprecated: Boolean = false, schema: ReferenceOr<JsonSchema>? = null, content: Map<@Serializable(with = ContentTypeSerializer::class) ContentType, MediaType>? = null, style: String? = null, explode: Boolean? = null, allowReserved: Boolean? = null, allowEmptyValue: Boolean? = null, example: GenericElement? = null, examples: Map<String, ReferenceOr<ExampleObject>>? = null, extensions: ExtensionProperties? = null)

Types

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

Builder for constructing a Parameter instance.

object Companion

Properties

allowEmptyValue

val ~~allowEmptyValue~~: Boolean?

Allows sending a parameter with an empty value (deprecated in OpenAPI 3.1).

val allowReserved: Boolean?

Determines if reserved characters :/?#[]@!$&'()*+,;= are allowed without percent-encoding.

val content: Map<@Serializable(with = ContentTypeSerializer::class) ContentType, MediaType>?

val deprecated: Boolean

Marks the parameter as deprecated if true.

val description: String?

A brief description of the parameter.

val example: GenericElement?

Example of the parameter's potential value.

val examples: Map<String, ReferenceOr<ExampleObject>>?

Map of examples for the parameter.

val explode: Boolean?

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

open override val extensions: ExtensionProperties?

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

val in: ParameterType?

val name: String

The name of the parameter.

val required: Boolean

Determines whether this parameter is mandatory.

val schema: ReferenceOr<JsonSchema>?

The schema defining the parameter type.

val style: String?

Describes how the parameter value will be serialized.