-
Notifications
You must be signed in to change notification settings - Fork 43
Config options
Zuzanna Stolińska edited this page May 24, 2017
·
1 revision
Config Name | Swagger parameter name | Description |
---|---|---|
config.swagger_url | url | The url pointing swagger.yaml (Swagger 2.0) as per OpenAPI Spec. This params requires hash value - pass your API doc version name as a key and it's main documentation url as a value. |
config.doc_expansion | docExpansion | Controls how the API listing is displayed. It can be set to 'none' (default), 'list' (shows operations for each resource), or 'full' (fully expanded: shows operations and their details). |
config.model_rendering | defaultModelRendering | Controls how models are shown when the API is first rendered. It can be set to 'model' or 'schema', and the default is 'schema'. |
config.request_headers | showRequestHeaders | Whether or not to show the headers that were sent when making a request via the 'Try it out!' option. Defaults to false . |
config.json_editor | jsonEditor | Enables a graphical view for editing complex bodies. Defaults to false . |
config.validator_enabled | validatorUrl | Enables documentation validator. Defaults to false (validatorUrl: 'null' ). |