forked from loafle/openapi-generator-original
bcc3a9ecf7
* WIP: add faraday support to Ruby client * update samples * bin/console * https only * ruby-faraday: Add a gemspec template for faraday * Add a test for ruby-faraday client options * Remove Gemfile.lock from ruby-client-faraday * Implement faraday client * Problem: can't use Faraday library for ruby clients Solution: add support for Faraday library This patch builds on the work started by @meganemura * Problem: Faraday is set as default library Solution: Make Typhoeus default This patch also updates the api_client template for Faraday to include query params with requests.
28 lines
1.7 KiB
Markdown
28 lines
1.7 KiB
Markdown
|
|
---
|
|
id: generator-opts-client-ruby
|
|
title: Config Options for ruby
|
|
sidebar_label: 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|
|
|
|faraday|Faraday (https://github.com/lostisland/faraday)| |false|
|
|
|typhoeus|Typhoeus (https://github.com/typhoeus/typhoeus)| |false|
|
|
|library|HTTP library template (sub-template) to use|<dl><dt>**faraday**</dt><dd>Faraday (https://github.com/lostisland/faraday)</dd><dt>**typhoeus**</dt><dd>Typhoeus >= 1.0.1 (https://github.com/typhoeus/typhoeus)</dd><dl>|faraday|
|