| allowUnicodeIdentifiers |
boolean, toggles whether unicode identifiers are allowed in names or not, default is false |
|
false |
| apiModulePrefix |
The prefix of the generated ApiModule. |
|
null |
| configurationPrefix |
The prefix of the generated Configuration. |
|
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 |
| enumNameSuffix |
Suffix that will be appended to all enum names. |
|
Enum |
| enumPropertyNaming |
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' |
|
PascalCase |
| fileNaming |
Naming convention for the output files: 'camelCase', 'kebab-case'. |
|
camelCase |
| 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 |
| modelFileSuffix |
The suffix of the file of the generated model (model<suffix>.ts). |
|
null |
| modelPropertyNaming |
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name. Only change it if you provide your own run-time code for (de-)serialization of models |
|
original |
| modelSuffix |
The suffix of the generated model. |
|
null |
| ngVersion |
The version of Angular. (At least 6.0.0) |
|
10.0.0 |
| npmName |
The name under which you want to publish generated npm package. Required to generate a full package |
|
null |
| npmRepository |
Use this property to set an url your private npmRepo in the package.json |
|
null |
| npmVersion |
The version of your npm package. If not provided, using the version from the OpenAPI specification file. |
|
1.0.0 |
| nullSafeAdditionalProps |
Set to make additional properties types declare that their indexer may return undefined |
|
false |
| prependFormOrBodyParameters |
Add form or body parameters to the beginning of the parameter list. |
|
false |
| providedInRoot |
Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0). |
|
false |
| queryParamObjectFormat |
The format for query param objects: 'dot', 'json', 'key'. |
|
dot |
| serviceFileSuffix |
The suffix of the file of the generated service (service<suffix>.ts). |
|
.service |
| serviceSuffix |
The suffix of the generated service. |
|
Service |
| snapshot |
When setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm |
|
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 |
| stringEnums |
Generate string enums instead of objects for enum values. |
|
false |
| supportsES6 |
Generate code that conforms to ES6. |
|
false |
| taggedUnions |
Use discriminators to create tagged unions instead of extending interfaces. |
|
false |
| useSingleRequestParameter |
Setting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter. |
|
false |
| withInterfaces |
Setting this property to true will generate interfaces next to the default class implementations. |
|
false |