Skip to content

Extension Options

Gary DeReese edited this page Mar 11, 2018 · 1 revision

When utilizing this package as a vorpal extension, an options object can be passed in the vorpal.use() function call for customizing the look and behavior of the generated CLI. The schemas for the options object is as follows:

options Schema

Property Type Description
operations object Options for how operations defined in the OpenAPI/Swagger spec are handled. See operations for details.
spec object (required) OpenAPI/Swagger specification object.

operations Schema

Property Type Description
groupBy string Indicates how operations defined in the spec will be grouped. none = no grouping, path = group by first path segment, tag = group by operation tags.
Clone this wiki locally