PathVariable

data class PathVariable(val name: String, val codec: StringCodec) : Parameter (source)

Required parameter rendered as a {name} segment inside the path template.

Path variables always remain required because omitting one would change the shape of the URI.

Constructors

constructor(name: String, codec: StringCodec)

Factory helpers for common path variable types.

open override val codec: StringCodec

Codec responsible for encoding and decoding parameter values.

open override val name: String

Canonical parameter name.

Location of the parameter within the HTTP request.

open override val required: Boolean = true

Indicates whether the parameter must be supplied by the caller.