OpenAPI Generator

OpenAPI Generator

  • Get Started
  • Generators
  • Roadmap
  • Team
  • FAQ
  • Blog

Config Options for ruby

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

IMPORT MAPPING

Type/AliasImports

INSTANTIATION TYPES

Type/AliasInstantiated 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
Last updated on 1/20/2020
  • IMPORT MAPPING
  • INSTANTIATION TYPES
  • LANGUAGE PRIMITIVES
  • RESERVED WORDS
OpenAPI Generator
Docs
Customizing GeneratorsWorkflow Integrations
Community
User ShowcaseStack OverflowChat RoomTwitter
More
BlogGitHub RepoStar
Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))