openapi-generator/docs/generators/ruby.md

title	sidebar_label
Config Options for ruby	ruby

Option	Description	Values	Default
sortParamsByRequiredFlag	Sort method arguments to place required parameters before optional parameters.		true
sortModelPropertiesByRequiredFlag	Sort model properties 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

IMPORT MAPPING

Type/Alias	Imports

INSTANTIATION TYPES

Type/Alias	Instantiated By

LANGUAGE PRIMITIVES

• string
• String
• Hash
• Date
• DateTime
• int
• Integer
• Array
• Float
• array
• Object
• Boolean
• File
• map

RESERVED WORDS

• next
• defined?
• def
• _header_accept_result
• _header_content_type
• for
• local_var_path
• form_params
• redo
• do
• elsif
• while
• when
• nil
• not
• unless
• and
• else
• yield
• alias
• end
• class
• if
• rescue
• case
• retry
• or
• ensure
• in
• break
• module
• false
• undef
• then
• _header_accept
• super
• header_params
• __line__
• auth_names
• __file__
• query_params
• true
• self
• until
• post_body
• begin
• send
• return