| allowFromJsonNulls |
allow JSON Null during model decoding from JSON |
|
true |
| allowNonUniqueOperationIds |
allow different API modules to contain the same operationId. Each API must be imported qualified |
|
false |
| allowToJsonNulls |
allow emitting JSON Null during model encoding to JSON |
|
false |
| allowUnicodeIdentifiers |
boolean, toggles whether unicode identifiers are allowed in names or not, default is false |
|
false |
| baseModule |
Set the base module namespace |
|
null |
| cabalPackage |
Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens |
|
null |
| cabalVersion |
Set the cabal version number, consisting of a sequence of one or more integers separated by dots |
|
null |
| configType |
Set the name of the type used for configuration |
|
null |
| customTestInstanceModule |
test module used to provide typeclass instances for types not known by the generator |
|
null |
| dateFormat |
format string used to parse/render a date |
|
%Y-%m-%d |
| dateTimeFormat |
format string used to parse/render a datetime |
|
null |
| dateTimeParseFormat |
overrides the format string used to parse a datetime |
|
null |
| disallowAdditionalPropertiesIfNotPresent |
Specify the behavior when the 'additionalProperties' keyword is not present in the OAS document. If false: the 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications. If true: when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.This setting is currently ignored for OAS 2.0 documents: 1) When the 'additionalProperties' keyword is not present in a 2.0 schema, additional properties are NOT allowed. 2) Boolean values of the 'additionalProperties' keyword are ignored. It's as if additional properties are NOT allowed.Note: the root cause are issues #1369 and #1371, which must be resolved in the swagger-parser project. |
- false
- The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
- true
- when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is automatically set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.
|
true |
| ensureUniqueParams |
Whether to ensure parameter names are unique in an operation (rename parameters that are not). |
|
true |
| generateEnums |
Generate specific datatypes for OpenAPI enums |
|
true |
| generateFormUrlEncodedInstances |
Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded |
|
true |
| generateLenses |
Generate Lens optics for Models |
|
true |
| generateModelConstructors |
Generate smart constructors (only supply required fields) for models |
|
true |
| hideGenerationTimestamp |
Hides the generation timestamp when files are generated. |
|
true |
| inlineMimeTypes |
Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option |
|
true |
| legacyDiscriminatorBehavior |
This flag is used by OpenAPITools codegen to influence the processing of the discriminator attribute in OpenAPI documents. This flag has no impact if the OAS document does not use the discriminator attribute. The default value of this flag is set in each language-specific code generator (e.g. Python, Java, go...)using the method toModelName. Note to developers supporting a language generator in OpenAPITools; to fully support the discriminator attribute as defined in the OAS specification 3.x, language generators should set this flag to true by default; however this requires updating the mustache templates to generate a language-specific discriminator lookup function that iterates over {{#mappedModels}} and does not iterate over {{children}}, {{#anyOf}}, or {{#oneOf}}. |
- 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 |
| modelDeriving |
Additional classes to include in the deriving() clause of Models |
|
null |
| prependFormOrBodyParameters |
Add form or body parameters to the beginning of the parameter list. |
|
false |
| requestType |
Set the name of the type used to generate requests |
|
null |
| sortModelPropertiesByRequiredFlag |
Sort model properties to place required parameters before optional parameters. |
|
true |
| sortParamsByRequiredFlag |
Sort method arguments to place required parameters before optional parameters. |
|
true |
| strictFields |
Add strictness annotations to all model fields |
|
true |
| useKatip |
Sets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-logger |
|
true |
