generators/ruby

id: generator-opts-client-ruby title: Config Options for rubysidebar_label: ruby

OptionDescriptionValuesDefault
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
gemNamegem name (convention: underscore_case).openapi_client
moduleNametop module name (convention: CamelCase, usually corresponding to gem name).OpenAPIClient
gemVersiongem version.1.0.0
gemLicensegem license.unlicense
gemRequiredRubyVersiongem required Ruby version.>= 1.9
gemHomepagegem homepage.http://org.openapitools
gemSummarygem summary.A ruby wrapper for the REST APIs
gemDescriptiongem description.This gem maps to a REST API
gemAuthorgem author (only one is supported).null
gemAuthorEmailgem author email (only one is supported).null
hideGenerationTimestampHides the generation timestamp when files are generated.true
libraryHTTP 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