PathVariable

annotation class PathVariable(val name: String = "", val nestedPath: Array<String> = [], val required: Boolean = true)

Marks a command field as a path variable in the generated URL.

Path variables are extracted from the URL path and injected into the command. This enables REST-style URLs with dynamic segments.

Parameters

name

The name of the path variable. If empty, uses the field name.

nestedPath

Path to nested properties for complex objects (e.g., "user", "id").

required

Whether this path variable is mandatory. Affects URL generation.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val required: Boolean = true