loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-05-30 21:40:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
openapi-generator-original/docs/generators/ruby.md
Jim Schubert 644f720db8
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) 
* [config-help] Sort all outputs

* Remove old/stale generator docs (these have been renamed previously)

* Sort config doc outputs, making it easier to find relevant info

* Fixes cliOptions duplicates

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.

* Add --github-nested-index for generating docs/generators/README.md

* 📝 Regenerate generator docs
2020-01-19 20:19:11 -05:00

3.1 KiB
Raw Blame History

title sidebar_label
Config Options for ruby ruby
Option Description Values Default
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
gemAuthor gem author (only one is supported). null
gemAuthorEmail gem author email (only one is supported). null
gemDescription gem description. This gem maps to a REST API
gemHomepage gem homepage. http://org.openapitools
gemLicense gem license. unlicense
gemName gem name (convention: underscore_case). openapi_client
gemRequiredRubyVersion gem required Ruby version. >= 1.9
gemSummary gem summary. A ruby wrapper for the REST APIs
gemVersion gem version. 1.0.0
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
moduleName top module name (convention: CamelCase, usually corresponding to gem name). OpenAPIClient
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. true
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By

LANGUAGE PRIMITIVES

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

RESERVED WORDS

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