Skip to main content

Interface: Route

Defined in: generateCliRoutes.ts:47

Properties​

description​

description: string

Defined in: generateCliRoutes.ts:51

operation summary/description

flags​

flags: Flag[]

Defined in: generateCliRoutes.ts:61

snake_case flags (path, query, body) with metadata for --help.

httpMethod​

httpMethod: "get" | "post" | "put" | "patch" | "delete"

Defined in: generateCliRoutes.ts:55

HTTP method the operation is mounted on

moduleDocsUrl​

moduleDocsUrl: string

Defined in: generateCliRoutes.ts:53

URL to module documentation page

operationId​

operationId: string

Defined in: generateCliRoutes.ts:49

pathParams​

pathParams: string[]

Defined in: generateCliRoutes.ts:57

snake_case path parameter names

queryParams​

queryParams: string[]

Defined in: generateCliRoutes.ts:59

snake_case query parameter names

serviceClass​

serviceClass: string

Defined in: generateCliRoutes.ts:48