Skip to main content

Interface: Route

Defined in: generateCliRoutes.ts:80

Properties​

cookieParams​

cookieParams: string[]

Defined in: generateCliRoutes.ts:96

snake_case cookie parameter names

description​

description: string

Defined in: generateCliRoutes.ts:84

operation summary/description

flags​

flags: Flag[]

Defined in: generateCliRoutes.ts:98

snake_case flags (every parameter location, plus body) with metadata for --help.

headerParams​

headerParams: string[]

Defined in: generateCliRoutes.ts:94

snake_case header parameter names

httpMethod​

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

Defined in: generateCliRoutes.ts:88

HTTP method the operation is mounted on

moduleDocsUrl​

moduleDocsUrl: string

Defined in: generateCliRoutes.ts:86

URL to module documentation page

operationId​

operationId: string

Defined in: generateCliRoutes.ts:82

pathParams​

pathParams: string[]

Defined in: generateCliRoutes.ts:90

snake_case path parameter names

queryParams​

queryParams: string[]

Defined in: generateCliRoutes.ts:92

snake_case query parameter names

serviceClass​

serviceClass: string

Defined in: generateCliRoutes.ts:81