| allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false | | false |
| disallowAdditionalPropertiesIfNotPresent | If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default. | - false
- The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
- true
- Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
| true |
| ensureUniqueParams | Whether to ensure parameter names are unique in an operation (rename parameters that are not). | | true |
| enumUnknownDefaultCase | If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case. | - false
- No changes to the enum's are made, this is the default option.
- true
- With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
| false |
| gemAuthor | gem author (only one is supported). | | OpenAPI-Generator |
| gemAuthorEmail | gem author email (only one is supported). | | null |
| gemDescription | gem description. | | This gem maps to a REST API |
| gemHomepage | gem homepage. | | https://openapi-generator.tech |
| gemLicense | gem license. | | unlicense |
| gemMetadata | gem metadata. | | {} |
| gemName | gem name (convention: underscore_case). | | openapi_client |
| gemRequiredRubyVersion | gem required Ruby version. | | >= 2.4 |
| 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 |
| legacyDiscriminatorBehavior | Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default). | - true
- The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
- false
- The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
| true |
| library | HTTP library template (sub-template) to use | - faraday
- Faraday >= 1.0.1 (https://github.com/lostisland/faraday)
- httpx
- HTTPX >= 1.0.0 (https://gitlab.com/os85/httpx)
- 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 |
| useAutoload | Use autoload instead of require to load modules. | | false |