PathVariable

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

Required path parameter definition.

Constructors

constructor(name: String, codec: StringCodec)

Factory helpers for building PathVariable definitions backed by common codecs.

open override val codec: StringCodec

codec used to encode and decode path values.

open override val name: String

canonical parameter name embedded in the URI template.

Location of the parameter within the HTTP request.

open override val required: Boolean = true

Indicates whether the parameter must be supplied by the caller.