Skip to main content

Interface: Flag

Defined in: generateCliRoutes.ts:61

Metadata for a single CLI flag, used to render --help output.

Properties​

description​

description: string

Defined in: generateCliRoutes.ts:64

in​

in: "path" | "query" | "header" | "cookie" | "body" | "body-root"

Defined in: generateCliRoutes.ts:77

Where the value is sent: a parameter location, a property of the request body (body), or the entire request body (body-root), for a body that names no property.

name​

name: string

Defined in: generateCliRoutes.ts:63

flag name in snake_case (e.g. project_id)

required​

required: boolean

Defined in: generateCliRoutes.ts:65

type​

type: string

Defined in: generateCliRoutes.ts:71

The schema's JSON type, or UNKNOWN_FLAG_TYPE when the schema admits more than one — a consumer should JSON-parse those rather than send them as text.