Jim Schubert 0e1ce6bb63
[docs] Custom template clarifications and other minor enhancements (#4167)
* [docs] Updating docsite outputs to be browsable on Github as well

* Fix links to other files
   Suffix `.md` was needed to make links works

* [docs] Add clarification to differences between customization and templating docs

* [docs] Collapsible side bar, scroll to top, minor enhancements
2019-10-16 18:04:44 -04:00

1.5 KiB

title sidebar_label
Config Options for ruby ruby
Option Description Values Default
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
gemName gem name (convention: underscore_case). openapi_client
moduleName top module name (convention: CamelCase, usually corresponding to gem name). OpenAPIClient
gemVersion gem version. 1.0.0
gemLicense gem license. unlicense
gemRequiredRubyVersion gem required Ruby version. >= 1.9
gemHomepage gem homepage. http://org.openapitools
gemSummary gem summary. A ruby wrapper for the REST APIs
gemDescription gem description. This gem maps to a REST API
gemAuthor gem author (only one is supported). null
gemAuthorEmail gem author email (only one is supported). null
hideGenerationTimestamp Hides the generation timestamp when files are generated. true
library HTTP library template (sub-template) to use
faraday
Faraday (https://github.com/lostisland/faraday) (Beta support)
typhoeus
Typhoeus >= 1.0.1 (https://github.com/typhoeus/typhoeus)
typhoeus