QueryParameter

data class QueryParameter<Q : Any>(val name: String, val codec: StringCodec<Q>, val default: Option<Q?>) : Parameter<Q> (source)

Query-string parameter that may be required or optional.

Query parameters become optional only when default is present, which gives generated code a value to use when the caller omits the parameter.

Constructors

constructor(name: String, codec: StringCodec<Q>, default: Option<Q?>)

Factory helpers for common query parameter types.

open override val codec: StringCodec<Q>

Codec responsible for encoding and decoding parameter values.

val default: Option<Q?>

fallback used when the parameter is omitted. None means the parameter is required.

open override val name: String

Canonical parameter name.

Location of the parameter within the HTTP request.

open override val required: Boolean

Indicates whether the parameter must be supplied by the caller.

fun optional(default: Q? = null): QueryParameter<Q>

Marks this query parameter as optional by recording the default to use when it is absent.