diff --git a/docs/generators/ada-server.md b/docs/generators/ada-server.md index 8762b5e3dbaf..f2a19294c623 100644 --- a/docs/generators/ada-server.md +++ b/docs/generators/ada-server.md @@ -27,6 +27,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |openApiName|The name of the Ada package which provides support for OpenAPI for the generated client and server code. The default is 'Swagger'.| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |projectName|GNAT project name| |defaultProject| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/ada.md b/docs/generators/ada.md index 866f60e5c351..8cdc065b5528 100644 --- a/docs/generators/ada.md +++ b/docs/generators/ada.md @@ -27,6 +27,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |openApiName|The name of the Ada package which provides support for OpenAPI for the generated client and server code. The default is 'Swagger'.| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |projectName|GNAT project name| |defaultProject| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/android.md b/docs/generators/android.md index 44d974431739..c1e4fccdb480 100644 --- a/docs/generators/android.md +++ b/docs/generators/android.md @@ -34,6 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |library|library template (sub-template) to use|
**volley**
HTTP client: Volley 1.0.19 (default)
**httpclient**
HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be deprecated in the next major release.
|null| |modelPackage|package for generated models| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serializableModel|boolean - toggle "implements Serializable" for generated models| |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| diff --git a/docs/generators/apache2.md b/docs/generators/apache2.md index 29c6859fe3ca..aa1b0dbad458 100644 --- a/docs/generators/apache2.md +++ b/docs/generators/apache2.md @@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |userInfoPath|Path to the user and group files| |null| diff --git a/docs/generators/apex.md b/docs/generators/apex.md index 490be47dfd02..96dab269db25 100644 --- a/docs/generators/apex.md +++ b/docs/generators/apex.md @@ -28,6 +28,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |namedCredential|The named credential name for the HTTP callouts| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/asciidoc.md b/docs/generators/asciidoc.md index 96666aedf42a..d4d3507f2c59 100644 --- a/docs/generators/asciidoc.md +++ b/docs/generators/asciidoc.md @@ -35,6 +35,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |licenseInfo|a short description of the license| |null| |licenseUrl|a URL pointing to the full license| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |skipExamples|skip examples sections (default: false)| |false| |snippetDir|path with includable markup snippets (e.g. test output generated by restdoc, default: .)| |.| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| diff --git a/docs/generators/avro-schema.md b/docs/generators/avro-schema.md index 82ca92af9f97..047eb96dc04c 100644 --- a/docs/generators/avro-schema.md +++ b/docs/generators/avro-schema.md @@ -25,6 +25,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |packageName|package for generated classes (where supported)| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/bash.md b/docs/generators/bash.md index 2975eed1ba0e..6e0203ae6b9e 100644 --- a/docs/generators/bash.md +++ b/docs/generators/bash.md @@ -31,6 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |processMarkdown|Convert all Markdown Markup into terminal formatting| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scriptName|The name of the script that will be generated (e.g. petstore-cli)| |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| diff --git a/docs/generators/c.md b/docs/generators/c.md index 7ae767d40522..1a129fcd538f 100644 --- a/docs/generators/c.md +++ b/docs/generators/c.md @@ -25,6 +25,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |useJsonUnformatted|Use cJSON_PrintUnformatted instead of cJSON_Print when creating the JSON string.| |false| diff --git a/docs/generators/clojure.md b/docs/generators/clojure.md index f8afb80b8934..22410759466e 100644 --- a/docs/generators/clojure.md +++ b/docs/generators/clojure.md @@ -31,6 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |projectName|name of the project (Default: generated from info.title or "openapi-clj-client")| |null| |projectUrl|URL of the project (Default: using info.contact.url or not included in project.clj)| |null| |projectVersion|version of the project (Default: using info.version or "1.0.0")| |null| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/cpp-qt-client.md b/docs/generators/cpp-qt-client.md index 76ffcff4068e..559017e6fdd7 100644 --- a/docs/generators/cpp-qt-client.md +++ b/docs/generators/cpp-qt-client.md @@ -29,6 +29,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |optionalProjectFile|Generate client.pri.| |true| |packageName|C++ package (library) name.| |QtOpenAPIClient| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/cpp-qt-qhttpengine-server.md b/docs/generators/cpp-qt-qhttpengine-server.md index 185d84f74b75..852f7a350beb 100644 --- a/docs/generators/cpp-qt-qhttpengine-server.md +++ b/docs/generators/cpp-qt-qhttpengine-server.md @@ -27,6 +27,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |modelNamePrefix|Prefix that will be prepended to all model names.| |OAI| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/cpp-tiny.md b/docs/generators/cpp-tiny.md index 99102d0697e0..0cf0cc2e3b9f 100644 --- a/docs/generators/cpp-tiny.md +++ b/docs/generators/cpp-tiny.md @@ -25,6 +25,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/cpp-tizen.md b/docs/generators/cpp-tizen.md index f033687c2b39..f6520e79b922 100644 --- a/docs/generators/cpp-tizen.md +++ b/docs/generators/cpp-tizen.md @@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/cpp-ue4.md b/docs/generators/cpp-ue4.md index bc0cc4b47f4f..582e26c6897b 100644 --- a/docs/generators/cpp-ue4.md +++ b/docs/generators/cpp-ue4.md @@ -26,6 +26,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |optionalProjectFile|Generate Build.cs| |true| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/crystal.md b/docs/generators/crystal.md index b9d588123329..559c1a6b40ba 100644 --- a/docs/generators/crystal.md +++ b/docs/generators/crystal.md @@ -26,6 +26,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |moduleName|module name (e.g. TwitterClient| |OpenAPIClient| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |shardAuthor|shard author (only one is supported).| |null| |shardAuthorEmail|shard author email (only one is supported).| |null| |shardDescription|shard description.| |This shard maps to a REST API| diff --git a/docs/generators/cwiki.md b/docs/generators/cwiki.md index 01da2a29f3f5..bbc2a8e82134 100644 --- a/docs/generators/cwiki.md +++ b/docs/generators/cwiki.md @@ -33,6 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |licenseInfo|a short description of the license| |null| |licenseUrl|a URL pointing to the full license| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/dart-dio.md b/docs/generators/dart-dio.md index f93b09ffbf8d..396df89d04f9 100644 --- a/docs/generators/dart-dio.md +++ b/docs/generators/dart-dio.md @@ -36,6 +36,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |pubPublishTo|Publish_to in generated pubspec| |null| |pubRepository|Repository in generated pubspec| |null| |pubVersion|Version in generated pubspec| |1.0.0| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serializationLibrary|Specify serialization library|
**built_value**
[DEFAULT] built_value
**json_serializable**
[BETA] json_serializable
|built_value| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/dart.md b/docs/generators/dart.md index 79148a7e4791..a1846bf5d1ad 100644 --- a/docs/generators/dart.md +++ b/docs/generators/dart.md @@ -33,6 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |pubPublishTo|Publish_to in generated pubspec| |null| |pubRepository|Repository in generated pubspec| |null| |pubVersion|Version in generated pubspec| |1.0.0| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serializationLibrary|Specify serialization library|
**native_serialization**
Use native serializer, backwards compatible
|native_serialization| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/dynamic-html.md b/docs/generators/dynamic-html.md index c202321b816f..302ddfc09457 100644 --- a/docs/generators/dynamic-html.md +++ b/docs/generators/dynamic-html.md @@ -27,6 +27,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |invokerPackage|root package for generated code| |null| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/elixir.md b/docs/generators/elixir.md index bc1a7a9beb88..f050e2051074 100644 --- a/docs/generators/elixir.md +++ b/docs/generators/elixir.md @@ -27,6 +27,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |licenseHeader|The license header to prepend to the top of all source files.| |null| |packageName|Elixir package name (convention: lowercase).| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/fsharp-functions.md b/docs/generators/fsharp-functions.md index a20382152aab..fcad4fa2adf6 100644 --- a/docs/generators/fsharp-functions.md +++ b/docs/generators/fsharp-functions.md @@ -32,6 +32,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library| |packageVersion|F# package version.| |1.0.0| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |OpenAPI/src| diff --git a/docs/generators/groovy.md b/docs/generators/groovy.md index 12bc9a24ae90..06ee0040c8cd 100644 --- a/docs/generators/groovy.md +++ b/docs/generators/groovy.md @@ -56,6 +56,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/haskell-http-client.md b/docs/generators/haskell-http-client.md index 5bb4352ec301..b0aed73dd261 100644 --- a/docs/generators/haskell-http-client.md +++ b/docs/generators/haskell-http-client.md @@ -43,6 +43,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |queryExtraUnreserved|Configures additional querystring characters which must not be URI encoded, e.g. '+' or ':'| |null| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/haskell-yesod.md b/docs/generators/haskell-yesod.md index d3694b12ed50..df3cd768a529 100644 --- a/docs/generators/haskell-yesod.md +++ b/docs/generators/haskell-yesod.md @@ -26,6 +26,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |projectName|name of the project (Default: generated from info.title or "openapi-haskell-yesod-server")| |null| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/haskell.md b/docs/generators/haskell.md index dfada1754f43..de7e3ab39d04 100644 --- a/docs/generators/haskell.md +++ b/docs/generators/haskell.md @@ -26,6 +26,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |modelPackage|package for generated models| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serveStatic|serve will serve files from the directory 'static'.| |true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/html.md b/docs/generators/html.md index 719041987dcf..ce9db83c221c 100644 --- a/docs/generators/html.md +++ b/docs/generators/html.md @@ -33,6 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |licenseInfo|a short description of the license| |null| |licenseUrl|a URL pointing to the full license| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/html2.md b/docs/generators/html2.md index f0ffcab1c633..5f74d928b320 100644 --- a/docs/generators/html2.md +++ b/docs/generators/html2.md @@ -37,6 +37,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |phpInvokerPackage|root package for generated php code| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |pythonPackageName|package name for generated python code| |null| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/java-camel.md b/docs/generators/java-camel.md index 58520d7461c8..667417a2a4ab 100644 --- a/docs/generators/java-camel.md +++ b/docs/generators/java-camel.md @@ -78,6 +78,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |performBeanValidation|Use Bean Validation Impl. to perform BeanValidation| |false| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |reactive|wrap responses in Mono/Flux Reactor types (spring-boot only)| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |requestMappingMode|Where to generate the class level @RequestMapping annotation.|
**api_interface**
Generate the @RequestMapping annotation on the generated Api Interface.
**controller**
Generate the @RequestMapping annotation on the generated Api Controller Implementation.
**none**
Do not add a class level @RequestMapping annotation.
|controller| |resourceFolder|resource folder for generated resources| |src/main/resources| |responseWrapper|wrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, RxObservable, RxSingle or fully qualified type)| |null| diff --git a/docs/generators/java-helidon-client.md b/docs/generators/java-helidon-client.md index 7f60cf91dbde..dca4e01068fe 100644 --- a/docs/generators/java-helidon-client.md +++ b/docs/generators/java-helidon-client.md @@ -54,6 +54,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |org.openapitools.client.model| |openApiNullable|Enable OpenAPI Jackson Nullable library| |true| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |rootJavaEEPackage|Root package name for Java EE| |Helidon 2.x and earlier: javax; Helidon 3.x and later: jakarta| |serializableModel|boolean - toggle "implements Serializable" for generated models| |false| |serializationLibrary|Serialization library, defaults to Jackson|
**jsonb**
Use JSON-B as serialization library
**jackson**
Use Jackson as serialization library
|null| diff --git a/docs/generators/java-helidon-server.md b/docs/generators/java-helidon-server.md index 2035bb8c6fbd..649187bdd5e1 100644 --- a/docs/generators/java-helidon-server.md +++ b/docs/generators/java-helidon-server.md @@ -55,6 +55,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |openApiNullable|Enable OpenAPI Jackson Nullable library| |true| |performBeanValidation|Perform BeanValidation| |false| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |rootJavaEEPackage|Root package name for Java EE| |Helidon 2.x and earlier: javax; Helidon 3.x and later: jakarta| |serializableModel|boolean - toggle "implements Serializable" for generated models| |false| |serializationLibrary|Serialization library, defaults to Jackson|
**jsonb**
Use JSON-B as serialization library
**jackson**
Use Jackson as serialization library
|null| diff --git a/docs/generators/java-inflector.md b/docs/generators/java-inflector.md index c97cc488b150..0e373a189084 100644 --- a/docs/generators/java-inflector.md +++ b/docs/generators/java-inflector.md @@ -58,6 +58,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/java-micronaut-client.md b/docs/generators/java-micronaut-client.md index f8c968280ec4..2d0e53451d97 100644 --- a/docs/generators/java-micronaut-client.md +++ b/docs/generators/java-micronaut-client.md @@ -71,6 +71,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |reactive|Make the responses use Reactor Mono as wrapper| |true| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |requiredPropertiesInConstructor|Allow only to create models with all the required properties provided in constructor| |true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| diff --git a/docs/generators/java-micronaut-server.md b/docs/generators/java-micronaut-server.md index 9cb2ad4dbbcb..405d03215152 100644 --- a/docs/generators/java-micronaut-server.md +++ b/docs/generators/java-micronaut-server.md @@ -69,6 +69,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |reactive|Make the responses use Reactor Mono as wrapper| |true| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |requiredPropertiesInConstructor|Allow only to create models with all the required properties provided in constructor| |true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| diff --git a/docs/generators/java-microprofile.md b/docs/generators/java-microprofile.md index 7eb9758f9f59..b1c7c07b3196 100644 --- a/docs/generators/java-microprofile.md +++ b/docs/generators/java-microprofile.md @@ -74,6 +74,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |performBeanValidation|Perform BeanValidation| |false| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/java-msf4j.md b/docs/generators/java-msf4j.md index 52455c5fea16..ff1ae49f331a 100644 --- a/docs/generators/java-msf4j.md +++ b/docs/generators/java-msf4j.md @@ -60,6 +60,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/java-pkmst.md b/docs/generators/java-pkmst.md index 6ecb576ac901..1f6f1e4b80e5 100644 --- a/docs/generators/java-pkmst.md +++ b/docs/generators/java-pkmst.md @@ -61,6 +61,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |pkmstInterceptor|PKMST Interceptor| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/java-play-framework.md b/docs/generators/java-play-framework.md index bfdef88970f0..cc8604acb6ed 100644 --- a/docs/generators/java-play-framework.md +++ b/docs/generators/java-play-framework.md @@ -62,6 +62,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/java-undertow-server.md b/docs/generators/java-undertow-server.md index 202f013209d0..865829caab7a 100644 --- a/docs/generators/java-undertow-server.md +++ b/docs/generators/java-undertow-server.md @@ -58,6 +58,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/java-vertx-web.md b/docs/generators/java-vertx-web.md index 3144df23e1a1..f6ced9ce831a 100644 --- a/docs/generators/java-vertx-web.md +++ b/docs/generators/java-vertx-web.md @@ -58,6 +58,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/java-vertx.md b/docs/generators/java-vertx.md index 4592996516e1..ba71fff83a23 100644 --- a/docs/generators/java-vertx.md +++ b/docs/generators/java-vertx.md @@ -58,6 +58,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |rxInterface|When specified, API interfaces are generated with RX and methods return Single<> and Comparable.| |false| |rxVersion2|When specified in combination with rxInterface, API interfaces are generated with RxJava2.| |false| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| diff --git a/docs/generators/java-wiremock.md b/docs/generators/java-wiremock.md index 081a1296745e..4ccb1bcc5c8c 100644 --- a/docs/generators/java-wiremock.md +++ b/docs/generators/java-wiremock.md @@ -58,6 +58,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/java.md b/docs/generators/java.md index c8b395bb02ed..b15a3edcf3d6 100644 --- a/docs/generators/java.md +++ b/docs/generators/java.md @@ -74,6 +74,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |performBeanValidation|Perform BeanValidation| |false| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/javascript-apollo-deprecated.md b/docs/generators/javascript-apollo-deprecated.md index c70d3e81b584..c0f55d48b635 100644 --- a/docs/generators/javascript-apollo-deprecated.md +++ b/docs/generators/javascript-apollo-deprecated.md @@ -37,6 +37,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |projectDescription|description of the project (Default: using info.description or "Client library of <projectName>")| |null| |projectName|name of the project (Default: generated from info.title or "openapi-js-client")| |null| |projectVersion|version of the project (Default: using info.version or "1.0.0")| |null| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |src| diff --git a/docs/generators/javascript-closure-angular.md b/docs/generators/javascript-closure-angular.md index 860b2f523f53..e8fd6f1c318a 100644 --- a/docs/generators/javascript-closure-angular.md +++ b/docs/generators/javascript-closure-angular.md @@ -25,6 +25,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |useEs6|use ES6 templates| |false| diff --git a/docs/generators/javascript-flowtyped.md b/docs/generators/javascript-flowtyped.md index b0c81d51a4fe..7cf128350e9f 100644 --- a/docs/generators/javascript-flowtyped.md +++ b/docs/generators/javascript-flowtyped.md @@ -33,6 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false| |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/javascript.md b/docs/generators/javascript.md index 2c4a02eee8f2..dd7599029ae5 100644 --- a/docs/generators/javascript.md +++ b/docs/generators/javascript.md @@ -38,6 +38,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |projectDescription|description of the project (Default: using info.description or "Client library of <projectName>")| |null| |projectName|name of the project (Default: generated from info.title or "openapi-js-client")| |null| |projectVersion|version of the project (Default: using info.version or "1.0.0")| |null| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |src| diff --git a/docs/generators/jaxrs-cxf-cdi.md b/docs/generators/jaxrs-cxf-cdi.md index f990de40ddb6..cb0de08c3a1d 100644 --- a/docs/generators/jaxrs-cxf-cdi.md +++ b/docs/generators/jaxrs-cxf-cdi.md @@ -63,6 +63,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| diff --git a/docs/generators/jaxrs-cxf-client.md b/docs/generators/jaxrs-cxf-client.md index 68d153daf209..930058feb55e 100644 --- a/docs/generators/jaxrs-cxf-client.md +++ b/docs/generators/jaxrs-cxf-client.md @@ -58,6 +58,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/jaxrs-cxf-extended.md b/docs/generators/jaxrs-cxf-extended.md index f72c477c3b73..6e4dae827d81 100644 --- a/docs/generators/jaxrs-cxf-extended.md +++ b/docs/generators/jaxrs-cxf-extended.md @@ -66,6 +66,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/jaxrs-cxf.md b/docs/generators/jaxrs-cxf.md index 89caf27c7ad3..cec8656a6c8e 100644 --- a/docs/generators/jaxrs-cxf.md +++ b/docs/generators/jaxrs-cxf.md @@ -64,6 +64,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/jaxrs-jersey.md b/docs/generators/jaxrs-jersey.md index d3b30f001e46..5f6e728ab487 100644 --- a/docs/generators/jaxrs-jersey.md +++ b/docs/generators/jaxrs-jersey.md @@ -60,6 +60,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/jaxrs-resteasy-eap.md b/docs/generators/jaxrs-resteasy-eap.md index 8645361f8435..683f27f1b279 100644 --- a/docs/generators/jaxrs-resteasy-eap.md +++ b/docs/generators/jaxrs-resteasy-eap.md @@ -60,6 +60,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/jaxrs-resteasy.md b/docs/generators/jaxrs-resteasy.md index af6e8c0aa2dd..70c2dd57f25d 100644 --- a/docs/generators/jaxrs-resteasy.md +++ b/docs/generators/jaxrs-resteasy.md @@ -60,6 +60,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator| diff --git a/docs/generators/jaxrs-spec.md b/docs/generators/jaxrs-spec.md index f1ff6d31bb66..cfc7dfe94024 100644 --- a/docs/generators/jaxrs-spec.md +++ b/docs/generators/jaxrs-spec.md @@ -63,6 +63,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false| |scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| |scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git| diff --git a/docs/generators/jmeter.md b/docs/generators/jmeter.md index 085b94493518..e895d8c94855 100644 --- a/docs/generators/jmeter.md +++ b/docs/generators/jmeter.md @@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/k6.md b/docs/generators/k6.md index a8c4932adb8c..99c41171ca66 100644 --- a/docs/generators/k6.md +++ b/docs/generators/k6.md @@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/markdown.md b/docs/generators/markdown.md index 7572bca67301..9ebfb90edc7e 100644 --- a/docs/generators/markdown.md +++ b/docs/generators/markdown.md @@ -23,6 +23,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/nim.md b/docs/generators/nim.md index d61882b2bc94..403f5e549eca 100644 --- a/docs/generators/nim.md +++ b/docs/generators/nim.md @@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/nodejs-express-server.md b/docs/generators/nodejs-express-server.md index d766f4c8702a..1457bdb22608 100644 --- a/docs/generators/nodejs-express-server.md +++ b/docs/generators/nodejs-express-server.md @@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serverPort|TCP port to listen on.| |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| diff --git a/docs/generators/ocaml.md b/docs/generators/ocaml.md index d2bbfecfa3e0..6820c87d6c69 100644 --- a/docs/generators/ocaml.md +++ b/docs/generators/ocaml.md @@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/openapi-yaml.md b/docs/generators/openapi-yaml.md index 22566b22a045..52c203d856ef 100644 --- a/docs/generators/openapi-yaml.md +++ b/docs/generators/openapi-yaml.md @@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |outputFile|Output filename| |openapi/openapi.yaml| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/openapi.md b/docs/generators/openapi.md index aea32dad388c..3b7a8092f8f2 100644 --- a/docs/generators/openapi.md +++ b/docs/generators/openapi.md @@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |outputFileName|Output file name| |openapi.json| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/php-dt.md b/docs/generators/php-dt.md index 2cfe33eb3a7a..75a707ac0298 100644 --- a/docs/generators/php-dt.md +++ b/docs/generators/php-dt.md @@ -35,6 +35,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modern|use modern language features (generated code will require PHP 8.1)| |false| |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |srcBasePath|The directory to serve as source root.| |null| diff --git a/docs/generators/php-flight.md b/docs/generators/php-flight.md index 8b7c90a069be..18868ddea27f 100644 --- a/docs/generators/php-flight.md +++ b/docs/generators/php-flight.md @@ -35,6 +35,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |srcBasePath|The directory to serve as source root.| |null| diff --git a/docs/generators/php-laravel.md b/docs/generators/php-laravel.md index 0d452d056064..1857d9296144 100644 --- a/docs/generators/php-laravel.md +++ b/docs/generators/php-laravel.md @@ -34,6 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |srcBasePath|The directory to serve as source root.| |null| diff --git a/docs/generators/php-lumen.md b/docs/generators/php-lumen.md index 39203422b3d4..1b12dcde8991 100644 --- a/docs/generators/php-lumen.md +++ b/docs/generators/php-lumen.md @@ -34,6 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |srcBasePath|The directory to serve as source root.| |null| diff --git a/docs/generators/php-mezzio-ph.md b/docs/generators/php-mezzio-ph.md index d724c85d0878..ca14b1ee6704 100644 --- a/docs/generators/php-mezzio-ph.md +++ b/docs/generators/php-mezzio-ph.md @@ -35,6 +35,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modern|use modern language features (generated code will require PHP 8.0)| |false| |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |srcBasePath|The directory to serve as source root.| |null| diff --git a/docs/generators/php-nextgen.md b/docs/generators/php-nextgen.md index f0f5a44a0fdb..2907740f3a89 100644 --- a/docs/generators/php-nextgen.md +++ b/docs/generators/php-nextgen.md @@ -35,6 +35,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |srcBasePath|The directory to serve as source root.| |null| diff --git a/docs/generators/php-slim4.md b/docs/generators/php-slim4.md index 7f3ca80191de..f7f1fa041cef 100644 --- a/docs/generators/php-slim4.md +++ b/docs/generators/php-slim4.md @@ -35,6 +35,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |psr7Implementation|Slim 4 provides its own PSR-7 implementation so that it works out of the box. However, you are free to replace Slim’s default PSR-7 objects with a third-party implementation. Ref: https://www.slimframework.com/docs/v4/concepts/value-objects.html|
**slim-psr7**
Slim PSR-7 Message implementation
**nyholm-psr7**
Nyholm PSR-7 Message implementation
**guzzle-psr7**
Guzzle PSR-7 Message implementation
**zend-diactoros**
Zend Diactoros PSR-7 Message implementation
|slim-psr7| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |srcBasePath|The directory to serve as source root.| |null| diff --git a/docs/generators/php-symfony.md b/docs/generators/php-symfony.md index 0e183bc9cc2e..b11bdfa162cb 100644 --- a/docs/generators/php-symfony.md +++ b/docs/generators/php-symfony.md @@ -40,6 +40,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| |phpLegacySupport|Should the generated code be compatible with PHP 5.x?| |true| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |srcBasePath|The directory to serve as source root.| |null| diff --git a/docs/generators/php.md b/docs/generators/php.md index b3997fb00d7e..598917ea0973 100644 --- a/docs/generators/php.md +++ b/docs/generators/php.md @@ -36,6 +36,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |srcBasePath|The directory to serve as source root.| |null| diff --git a/docs/generators/plantuml.md b/docs/generators/plantuml.md index 2149de62f1ef..e0d31ac00625 100644 --- a/docs/generators/plantuml.md +++ b/docs/generators/plantuml.md @@ -23,6 +23,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/python-aiohttp.md b/docs/generators/python-aiohttp.md index b99acea11527..cef04f8cd94f 100644 --- a/docs/generators/python-aiohttp.md +++ b/docs/generators/python-aiohttp.md @@ -31,6 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageVersion|python package version.| |1.0.0| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |pythonSrcRoot|put python sources in this subdirectory of output folder (defaults to "" for). Use this for src/ layout.| || +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serverPort|TCP port to listen to in app.run| |8080| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/python-blueplanet.md b/docs/generators/python-blueplanet.md index 2702fd49c5fe..0fcd268d3a1a 100644 --- a/docs/generators/python-blueplanet.md +++ b/docs/generators/python-blueplanet.md @@ -31,6 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageVersion|python package version.| |1.0.0| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |pythonSrcRoot|put python sources in this subdirectory of output folder (defaults to "" for). Use this for src/ layout.| || +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serverPort|TCP port to listen to in app.run| |8080| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/python-fastapi.md b/docs/generators/python-fastapi.md index 0beee68d757d..76c5aaf7b859 100644 --- a/docs/generators/python-fastapi.md +++ b/docs/generators/python-fastapi.md @@ -28,6 +28,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|python package name (convention: snake_case).| |openapi_server| |packageVersion|python package version.| |1.0.0| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serverPort|TCP port to listen to in app.run| |8080| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/python-flask.md b/docs/generators/python-flask.md index 81be38100b7e..b4e0eb8872c8 100644 --- a/docs/generators/python-flask.md +++ b/docs/generators/python-flask.md @@ -31,6 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageVersion|python package version.| |1.0.0| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |pythonSrcRoot|put python sources in this subdirectory of output folder (defaults to "" for). Use this for src/ layout.| || +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serverPort|TCP port to listen to in app.run| |8080| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/ruby.md b/docs/generators/ruby.md index e643257b13e1..2d5df488b7bf 100644 --- a/docs/generators/ruby.md +++ b/docs/generators/ruby.md @@ -37,6 +37,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/scala-akka-http-server.md b/docs/generators/scala-akka-http-server.md index 15108cd3eb67..1ce0d1556a4b 100644 --- a/docs/generators/scala-akka-http-server.md +++ b/docs/generators/scala-akka-http-server.md @@ -34,6 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/scala-akka.md b/docs/generators/scala-akka.md index 7b9cf9267b58..be07cf00cd4a 100644 --- a/docs/generators/scala-akka.md +++ b/docs/generators/scala-akka.md @@ -29,6 +29,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/scala-cask.md b/docs/generators/scala-cask.md index 802870eef7b5..c1fb6198f9c3 100644 --- a/docs/generators/scala-cask.md +++ b/docs/generators/scala-cask.md @@ -34,6 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |packageName|packageDescription| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/scala-gatling.md b/docs/generators/scala-gatling.md index 903f6149bbc0..b197c38ed76e 100644 --- a/docs/generators/scala-gatling.md +++ b/docs/generators/scala-gatling.md @@ -28,6 +28,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/scala-http4s-server.md b/docs/generators/scala-http4s-server.md index 9031c8ef8948..ef69f917728d 100644 --- a/docs/generators/scala-http4s-server.md +++ b/docs/generators/scala-http4s-server.md @@ -25,6 +25,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |excludeSbt|exclude sbt from generation| |null| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceSubfolder|name of subfolder, for example to generate code in src/scala/generated| |null| diff --git a/docs/generators/scala-lagom-server.md b/docs/generators/scala-lagom-server.md index 2261851ca503..204132b1941c 100644 --- a/docs/generators/scala-lagom-server.md +++ b/docs/generators/scala-lagom-server.md @@ -28,6 +28,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/scala-pekko.md b/docs/generators/scala-pekko.md index ebc33bb69870..f4b3266af9bf 100644 --- a/docs/generators/scala-pekko.md +++ b/docs/generators/scala-pekko.md @@ -29,6 +29,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/scala-play-server.md b/docs/generators/scala-play-server.md index cc632ff4d726..35bb6aa06c04 100644 --- a/docs/generators/scala-play-server.md +++ b/docs/generators/scala-play-server.md @@ -29,6 +29,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |routesFileName|Name of the routes file to generate.| |routes| |skipStubs|If set, skips generation of stub classes.| |false| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| diff --git a/docs/generators/scala-sttp.md b/docs/generators/scala-sttp.md index b425573a5565..6cf272e6d817 100644 --- a/docs/generators/scala-sttp.md +++ b/docs/generators/scala-sttp.md @@ -32,6 +32,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |separateErrorChannel|Whether to return response as F[Either[ResponseError[ErrorType], ReturnType]]] or to flatten response's error raising them through enclosing monad (F[ReturnType]).| |true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/scala-sttp4.md b/docs/generators/scala-sttp4.md index 2ff0143b0eda..555366b957ff 100644 --- a/docs/generators/scala-sttp4.md +++ b/docs/generators/scala-sttp4.md @@ -32,6 +32,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |separateErrorChannel|Whether to return response as F[Either[ResponseError[ErrorType], ReturnType]]] or to flatten response's error raising them through enclosing monad (F[ReturnType]).| |true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/scalatra.md b/docs/generators/scalatra.md index 6621eaae2f4d..ea7480f55a80 100644 --- a/docs/generators/scalatra.md +++ b/docs/generators/scalatra.md @@ -28,6 +28,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/scalaz.md b/docs/generators/scalaz.md index 627af71ef68d..221f4afb6a92 100644 --- a/docs/generators/scalaz.md +++ b/docs/generators/scalaz.md @@ -28,6 +28,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/spring.md b/docs/generators/spring.md index d026204231ae..29067849fe1f 100644 --- a/docs/generators/spring.md +++ b/docs/generators/spring.md @@ -71,6 +71,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |performBeanValidation|Use Bean Validation Impl. to perform BeanValidation| |false| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |reactive|wrap responses in Mono/Flux Reactor types (spring-boot only)| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |requestMappingMode|Where to generate the class level @RequestMapping annotation.|
**api_interface**
Generate the @RequestMapping annotation on the generated Api Interface.
**controller**
Generate the @RequestMapping annotation on the generated Api Controller Implementation.
**none**
Do not add a class level @RequestMapping annotation.
|controller| |resourceFolder|resource folder for generated resources| |src/main/resources| |responseWrapper|wrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, RxObservable, RxSingle or fully qualified type)| |null| diff --git a/docs/generators/swift-combine.md b/docs/generators/swift-combine.md index d660a47af3ba..5e3624723399 100644 --- a/docs/generators/swift-combine.md +++ b/docs/generators/swift-combine.md @@ -27,6 +27,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |mapFileBinaryToData|Map File and Binary to Data (default: true)| |true| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |projectName|Project name in Xcode| |null| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/swift5.md b/docs/generators/swift5.md index 519ad121b837..bee4b7132c96 100644 --- a/docs/generators/swift5.md +++ b/docs/generators/swift5.md @@ -45,6 +45,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |projectName|Project name in Xcode| |null| |readonlyProperties|Make properties readonly (default: false)| |null| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |responseAs|Optionally use libraries to manage response. Currently PromiseKit, RxSwift, Result, Combine, AsyncAwait are available.| |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| diff --git a/docs/generators/typescript-angular.md b/docs/generators/typescript-angular.md index 16542b6a36d2..4db57bbb51f2 100644 --- a/docs/generators/typescript-angular.md +++ b/docs/generators/typescript-angular.md @@ -41,6 +41,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |providedIn|Use this property to provide Injectables in wanted level.|
**root**
The application-level injector in most apps.
**none**
No providedIn)
**any**
Provides a unique instance in each lazy loaded module while all eagerly loaded modules share one instance.
**platform**
A special singleton platform injector shared by all applications on the page.
|root| |queryParamObjectFormat|The format for query param objects: 'dot', 'json', 'key'.| |dot| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/typescript-aurelia.md b/docs/generators/typescript-aurelia.md index a4c3819c4dd0..47559db6d67c 100644 --- a/docs/generators/typescript-aurelia.md +++ b/docs/generators/typescript-aurelia.md @@ -32,6 +32,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false| |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/typescript-axios.md b/docs/generators/typescript-axios.md index 018c52b23a7c..f9c0042c0495 100644 --- a/docs/generators/typescript-axios.md +++ b/docs/generators/typescript-axios.md @@ -34,6 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false| |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/typescript-fetch.md b/docs/generators/typescript-fetch.md index e5216325d817..002786c80749 100644 --- a/docs/generators/typescript-fetch.md +++ b/docs/generators/typescript-fetch.md @@ -36,6 +36,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prefixParameterInterfaces|Setting this property to true will generate parameter interface declarations prefixed with API class name to avoid name conflicts.| |false| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sagasAndRecords|Setting this property to true will generate additional files for use with redux-saga and immutablejs.| |false| |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| diff --git a/docs/generators/typescript-inversify.md b/docs/generators/typescript-inversify.md index b38c0ff9afb7..8ff272126234 100644 --- a/docs/generators/typescript-inversify.md +++ b/docs/generators/typescript-inversify.md @@ -33,6 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false| |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/typescript-jquery.md b/docs/generators/typescript-jquery.md index 626ac5a920f5..583f65de0e9d 100644 --- a/docs/generators/typescript-jquery.md +++ b/docs/generators/typescript-jquery.md @@ -34,6 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false| |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/typescript-nestjs.md b/docs/generators/typescript-nestjs.md index 11748efb4eca..f23eaccca738 100644 --- a/docs/generators/typescript-nestjs.md +++ b/docs/generators/typescript-nestjs.md @@ -37,6 +37,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false| |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/typescript-node.md b/docs/generators/typescript-node.md index f19a9f34e5a3..4e7100aa3d4a 100644 --- a/docs/generators/typescript-node.md +++ b/docs/generators/typescript-node.md @@ -33,6 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false| |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/typescript-redux-query.md b/docs/generators/typescript-redux-query.md index 0e0aa2ec3ce3..c4b78b30b58b 100644 --- a/docs/generators/typescript-redux-query.md +++ b/docs/generators/typescript-redux-query.md @@ -33,6 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false| |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/typescript-rxjs.md b/docs/generators/typescript-rxjs.md index b5cdf9fe8a7a..67b98f60d313 100644 --- a/docs/generators/typescript-rxjs.md +++ b/docs/generators/typescript-rxjs.md @@ -33,6 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false| |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/typescript.md b/docs/generators/typescript.md index ed7612a0cea4..62e744a6158d 100644 --- a/docs/generators/typescript.md +++ b/docs/generators/typescript.md @@ -37,6 +37,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| |platform|Specifies the platform the code should run on. The default is 'node' for the 'request' framework and 'browser' otherwise.|
**browser**
browser
**node**
node
**deno**
deno
|browser| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |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| diff --git a/docs/generators/wsdl-schema.md b/docs/generators/wsdl-schema.md index 0d45c1d00d68..c454b0275647 100644 --- a/docs/generators/wsdl-schema.md +++ b/docs/generators/wsdl-schema.md @@ -26,6 +26,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |hostname|the hostname of the service| |null| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serviceName|service name for the wsdl| |null| |soapPath|basepath of the soap services| |null| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| diff --git a/docs/generators/xojo-client.md b/docs/generators/xojo-client.md index ed4358303c82..004912fb4531 100644 --- a/docs/generators/xojo-client.md +++ b/docs/generators/xojo-client.md @@ -30,6 +30,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |null| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |projectName|Project name in Xojo| |null| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |serializationLibrary|What serialization library to use: 'xoson' (default).| |xoson| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/docs/generators/zapier.md b/docs/generators/zapier.md index 220ae7e4df0a..9a5a7a69dc05 100644 --- a/docs/generators/zapier.md +++ b/docs/generators/zapier.md @@ -23,6 +23,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| |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| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|removeEnumValuePrefix|Remove the common prefix of enum values|
**false**
No changes to the enum's are made.
**true**
With this option disabled, each enum will have the common prefix between them removed. This is the default option.
|true| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| diff --git a/modules/openapi-generator-maven-plugin/src/test/java/org/openapitools/codegen/plugin/CodeGenMojoTest.java b/modules/openapi-generator-maven-plugin/src/test/java/org/openapitools/codegen/plugin/CodeGenMojoTest.java index 42db5395c259..83f577753f8f 100644 --- a/modules/openapi-generator-maven-plugin/src/test/java/org/openapitools/codegen/plugin/CodeGenMojoTest.java +++ b/modules/openapi-generator-maven-plugin/src/test/java/org/openapitools/codegen/plugin/CodeGenMojoTest.java @@ -34,6 +34,7 @@ import java.io.File; import java.io.IOException; +import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.StandardOpenOption; @@ -251,6 +252,16 @@ public void test_skipIfSpecIsUnchanged_recognizesUpdatesInExternalReferencedFile assertTrue("Src directory should have been regenerated", Files.exists(generatedDir.resolve("src"))); } + public void test_configOptions_removeEnumValuePrefix_issue18889() throws Exception { + final Path tempDir = newTempFolder(); + final CodeGenMojo mojo = loadMojo(tempDir, "src/test/resources/issue-18889", null); + mojo.execute(); + String fileContent = FileUtils.readFileToString(tempDir.resolve("target/generated-sources/issue-18889/src/main/java/org/openapitools/client/model/PetType.java").toFile(), StandardCharsets.UTF_8); + assertTrue("File content does not contain PET_CAT", fileContent.contains("PET_CAT(\"PET_CAT\"),")); + assertTrue("File content does not contain PET_DOG", fileContent.contains("PET_DOG(\"PET_DOG\"),")); + assertTrue("File content does not contain PET_LIZARD", fileContent.contains("PET_LIZARD(\"PET_LIZARD\");")); + } + protected CodeGenMojo loadMojo(Path temporaryFolder, String projectRoot, String profile) throws Exception { return loadMojo(temporaryFolder, projectRoot, profile, "default"); } diff --git a/modules/openapi-generator-maven-plugin/src/test/resources/issue-18889/issue_18889.yaml b/modules/openapi-generator-maven-plugin/src/test/resources/issue-18889/issue_18889.yaml new file mode 100644 index 000000000000..d5fabb90ffdc --- /dev/null +++ b/modules/openapi-generator-maven-plugin/src/test/resources/issue-18889/issue_18889.yaml @@ -0,0 +1,35 @@ +openapi: 3.0.0 +info: + title: test + description: >- + test schema + version: 1.0.0 +servers: + - url: 'http://test.com' + description: stage +paths: + /demo: + get: + summary: placeholder summary + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Pet' +components: + schemas: + Pet: + type: object + properties: + petType: + $ref: '#/components/schemas/PetType' + name: + type: string + PetType: + type: string + enum: + - PET_CAT + - PET_DOG + - PET_LIZARD \ No newline at end of file diff --git a/modules/openapi-generator-maven-plugin/src/test/resources/issue-18889/pom.xml b/modules/openapi-generator-maven-plugin/src/test/resources/issue-18889/pom.xml new file mode 100644 index 000000000000..ac2e4b33986e --- /dev/null +++ b/modules/openapi-generator-maven-plugin/src/test/resources/issue-18889/pom.xml @@ -0,0 +1,44 @@ + + 4.0.0 + common.maven + issue-18889 + jar + 1.0.0-SNAPSHOT + OpenAPI Generator Configuration Test + https://openapi-generator.tech/ + + + + org.openapitools + openapi-generator-maven-plugin + + java + + true + + native + ${basedir}/target/generated-sources/issue-18889 + hideGenerationTimestamp=true + ${basedir}/issue_18889.yaml + true + false + false + false + false + + false + + + + + generate + generate-sources + + generate + + + + + + + \ No newline at end of file diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java index 4c10d78a9ef1..dacd8dfa31cf 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java @@ -1783,6 +1783,18 @@ public DefaultCodegen() { cliOptions.add(enumUnknownDefaultCaseOpt); this.setEnumUnknownDefaultCase(false); + CliOption removeEnumValuePrefixOpt = CliOption.newBoolean( + CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, + CodegenConstants.REMOVE_ENUM_VALUE_PREFIX_DESC).defaultValue(Boolean.TRUE.toString()); + Map removeEnumValuePrefixOpts = new HashMap<>(); + removeEnumValuePrefixOpts.put("false", + "No changes to the enum's are made."); + removeEnumValuePrefixOpts.put("true", + "With this option disabled, each enum will have the common prefix between them removed. This is the default option."); + removeEnumValuePrefixOpt.setEnum(removeEnumValuePrefixOpts); + cliOptions.add(removeEnumValuePrefixOpt); + this.setRemoveEnumValuePrefix(true); + // initialize special character mapping initializeSpecialCharacterMapping(); diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java index a32101a09cd0..a5f5f8bf2f69 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java @@ -3148,6 +3148,48 @@ public void testXPatternMessage_issue5857() throws IOException { )); } + @Test + public void testOneOfSubType_issue15274() throws IOException { + File output = Files.createTempDirectory("test").toFile().getCanonicalFile(); + output.deleteOnExit(); + + final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/issue_15274.yaml"); + final SpringCodegen codegen = new SpringCodegen(); + codegen.setOpenAPI(openAPI); + codegen.setOutputDir(output.getAbsolutePath()); + + codegen.additionalProperties().put(SpringCodegen.DATE_LIBRARY, "java8-localdatetime"); + codegen.additionalProperties().put(INTERFACE_ONLY, "true"); + codegen.additionalProperties().put(USE_RESPONSE_ENTITY, "false"); + codegen.additionalProperties().put(DELEGATE_PATTERN, "true"); + codegen.additionalProperties().put(USE_ONE_OF_INTERFACES, "true"); + codegen.additionalProperties().put(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, "true"); + codegen.additionalProperties().put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, "false"); + + ClientOptInput input = new ClientOptInput(); + input.openAPI(openAPI); + input.config(codegen); + + DefaultGenerator generator = new DefaultGenerator(); + generator.setGenerateMetadata(false); // skip metadata generation + generator.setGeneratorPropertyDefault(CodegenConstants.MODELS, "true"); + + Map files = generator.opts(input).generate().stream() + .collect(Collectors.toMap(File::getName, Function.identity())); + + JavaFileAssert.assertThat(files.get("Pet.java")) + .isInterface() + .assertTypeAnnotations() + .containsWithName("JsonSubTypes"); + + String jsonSubType = "@JsonSubTypes({\n" + + " @JsonSubTypes.Type(value = Cat.class, name = \"PET_CAT\")," + + " @JsonSubTypes.Type(value = Dog.class, name = \"PET_DOG\")," + + " @JsonSubTypes.Type(value = Lizard.class, name = \"PET_LIZARD\")" + + "})"; + assertFileContains(files.get("Pet.java").toPath(), jsonSubType); + } + @Test public void testXPatternMessage_issue18959() throws IOException { File output = Files.createTempDirectory("test").toFile().getCanonicalFile(); diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/BashClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/BashClientOptionsProvider.java index 338a9e5ea13a..1e02e59a2fb3 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/BashClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/BashClientOptionsProvider.java @@ -40,6 +40,7 @@ public class BashClientOptionsProvider implements OptionsProvider { = "false"; public static final String PREPEND_FORM_OR_BODY_PARAMETERS_VALUE = "true"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -74,6 +75,7 @@ public Map createOptions() { .put(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, "true") .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/DartClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/DartClientOptionsProvider.java index 7851eb082362..39fa2eb23146 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/DartClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/DartClientOptionsProvider.java @@ -42,6 +42,7 @@ public class DartClientOptionsProvider implements OptionsProvider { public static final String ALLOW_UNICODE_IDENTIFIERS_VALUE = "false"; public static final String PREPEND_FORM_OR_BODY_PARAMETERS_VALUE = "true"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -71,6 +72,7 @@ public Map createOptions() { .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true") .put("serializationLibrary", "custom") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/DartDioClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/DartDioClientOptionsProvider.java index bcda220f4328..3e947cbb4c83 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/DartDioClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/DartDioClientOptionsProvider.java @@ -40,6 +40,7 @@ public class DartDioClientOptionsProvider implements OptionsProvider { public static final String PUB_REPOSITORY_VALUE = "Repository"; public static final String PUB_PUBLISH_TO_VALUE = "Publish to"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -72,6 +73,7 @@ public Map createOptions() { .put(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, "true") .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/ElixirClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/ElixirClientOptionsProvider.java index 32b7b3d34151..5ee90dea099d 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/ElixirClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/ElixirClientOptionsProvider.java @@ -26,6 +26,7 @@ public class ElixirClientOptionsProvider implements OptionsProvider { public static final String INVOKER_PACKAGE_VALUE = "Yay.Pets"; public static final String PREPEND_FORM_OR_BODY_PARAMETERS_VALUE = "true"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -47,6 +48,7 @@ public Map createOptions() { .put(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, "true") .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/HaskellServantOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/HaskellServantOptionsProvider.java index b6cb61abc193..4e18bf4cca63 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/HaskellServantOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/HaskellServantOptionsProvider.java @@ -32,6 +32,7 @@ public class HaskellServantOptionsProvider implements OptionsProvider { public static final String ALLOW_UNICODE_IDENTIFIERS_VALUE = "false"; public static final String PREPEND_FORM_OR_BODY_PARAMETERS_VALUE = "true"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -53,6 +54,7 @@ public Map createOptions() { .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) .put(HaskellServantCodegen.USE_CUSTOM_MONAD, HaskellServantCodegen.USE_CUSTOM_MONAD_DEFAULT.toString()) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/HaskellYesodServerOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/HaskellYesodServerOptionsProvider.java index 66fd08f19aaa..ec34f5a989fe 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/HaskellYesodServerOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/HaskellYesodServerOptionsProvider.java @@ -15,6 +15,7 @@ public class HaskellYesodServerOptionsProvider implements OptionsProvider { public static final String PROJECT_NAME_VALUE = "openapi-haskell-yesod-server"; public static final String API_MODULE_NAME_VALUE = "API"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -34,6 +35,7 @@ public Map createOptions() { .put(HaskellYesodServerCodegen.PROJECT_NAME, PROJECT_NAME_VALUE) .put(HaskellYesodServerCodegen.API_MODULE_NAME, API_MODULE_NAME_VALUE) .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpClientOptionsProvider.java index bf26ac750fa7..1dbe77379f45 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpClientOptionsProvider.java @@ -43,6 +43,7 @@ public class PhpClientOptionsProvider implements OptionsProvider { public static final String DEVELOPER_ORGANIZATION_VALUE = "openapi generator contributors"; public static final String COMPOSER_PACKAGE_NAME_VALUE = "package/name"; public static final String LIBRARY_VALUE = "psr-18"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -74,6 +75,7 @@ public Map createOptions() { .put(CodegenConstants.DEVELOPER_ORGANIZATION, DEVELOPER_ORGANIZATION_VALUE) .put(CodegenConstants.COMPOSER_PACKAGE_NAME, COMPOSER_PACKAGE_NAME_VALUE) .put(CodegenConstants.LIBRARY, LIBRARY_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpLumenServerOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpLumenServerOptionsProvider.java index ee795a038735..b67788d285ac 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpLumenServerOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpLumenServerOptionsProvider.java @@ -42,6 +42,7 @@ public class PhpLumenServerOptionsProvider implements OptionsProvider { public static final String ARTIFACTURL_VALUE = "https://anotherUrl.com"; public static final String DEVELOPER_ORGANIZATION_VALUE = "openapi generator contributors"; public static final String COMPOSER_PACKAGE_NAME_VALUE = "package/name"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -71,6 +72,7 @@ public Map createOptions() { .put(CodegenConstants.ARTIFACT_URL, ARTIFACTURL_VALUE) .put(CodegenConstants.DEVELOPER_ORGANIZATION, DEVELOPER_ORGANIZATION_VALUE) .put(CodegenConstants.COMPOSER_PACKAGE_NAME, COMPOSER_PACKAGE_NAME_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpSlim4ServerOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpSlim4ServerOptionsProvider.java index 7ebaece2aae3..f56f354cb27e 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpSlim4ServerOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpSlim4ServerOptionsProvider.java @@ -44,6 +44,7 @@ public class PhpSlim4ServerOptionsProvider implements OptionsProvider { public static final String ARTIFACTURL_VALUE = "https://anotherUrl.com"; public static final String DEVELOPER_ORGANIZATION_VALUE = "openapi generator contributors"; public static final String COMPOSER_PACKAGE_NAME_VALUE = "package/name"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -74,6 +75,7 @@ public Map createOptions() { .put(CodegenConstants.ARTIFACT_URL, ARTIFACTURL_VALUE) .put(CodegenConstants.DEVELOPER_ORGANIZATION, DEVELOPER_ORGANIZATION_VALUE) .put(CodegenConstants.COMPOSER_PACKAGE_NAME, COMPOSER_PACKAGE_NAME_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/RubyClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/RubyClientOptionsProvider.java index 4578b058af70..d1e5c54a9f48 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/RubyClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/RubyClientOptionsProvider.java @@ -43,6 +43,7 @@ public class RubyClientOptionsProvider implements OptionsProvider { public static final String LIBRARY = "typhoeus"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; public static final String USE_AUTOLOAD_VALUE = "true"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -74,6 +75,7 @@ public Map createOptions() { .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) .put(RubyClientCodegen.USE_AUTOLOAD, USE_AUTOLOAD_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/ScalaAkkaClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/ScalaAkkaClientOptionsProvider.java index 7c4e5d4a1b92..3313f1beea55 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/ScalaAkkaClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/ScalaAkkaClientOptionsProvider.java @@ -35,6 +35,7 @@ public class ScalaAkkaClientOptionsProvider implements OptionsProvider { public static final String MODEL_PROPERTY_NAMING = "camelCase"; public static final String DATE_LIBRARY = "joda"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override @@ -59,6 +60,7 @@ public Map createOptions() { .put(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, "true") .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/Swift5OptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/Swift5OptionsProvider.java index c9a5c4b2ae4f..22556b041548 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/Swift5OptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/Swift5OptionsProvider.java @@ -55,6 +55,7 @@ public class Swift5OptionsProvider implements OptionsProvider { public static final String USE_SPM_FILE_STRUCTURE_VALUE = "false"; public static final String SWIFT_PACKAGE_PATH_VALUE = ""; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -102,6 +103,7 @@ public Map createOptions() { .put(Swift5ClientCodegen.VALIDATABLE, "true") .put(Swift5ClientCodegen.USE_CLASSES, "false") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptAngularClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptAngularClientOptionsProvider.java index 2ffc324fc830..0c0aaf16fb06 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptAngularClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptAngularClientOptionsProvider.java @@ -52,6 +52,7 @@ public class TypeScriptAngularClientOptionsProvider implements OptionsProvider { public static String MODEL_FILE_SUFFIX = ""; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; public static final String ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -95,6 +96,7 @@ public Map createOptions() { .put(TypeScriptAngularClientCodegen.QUERY_PARAM_OBJECT_FORMAT, QUERY_PARAM_OBJECT_FORMAT_VALUE) .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) .put(TypeScriptAngularClientCodegen.USE_SQUARE_BRACKETS_IN_ARRAY_NAMES, Boolean.FALSE.toString()) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptAureliaClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptAureliaClientOptionsProvider.java index e975525974a6..f7767c261440 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptAureliaClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptAureliaClientOptionsProvider.java @@ -40,6 +40,7 @@ public class TypeScriptAureliaClientOptionsProvider implements OptionsProvider { public static final String PREPEND_FORM_OR_BODY_PARAMETERS_VALUE = "true"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; public static final String ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -67,6 +68,7 @@ public Map createOptions() { .put(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, "true") .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptFetchClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptFetchClientOptionsProvider.java index 2ac10fa6f327..7163d5130973 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptFetchClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptFetchClientOptionsProvider.java @@ -49,6 +49,7 @@ public class TypeScriptFetchClientOptionsProvider implements OptionsProvider { public static final String STRING_ENUMS = "false"; public static final String FILE_NAMING_VALUE = PASCAL_CASE; public static final String ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -86,6 +87,7 @@ public Map createOptions() { .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) .put(TypeScriptFetchClientCodegen.STRING_ENUMS, STRING_ENUMS) .put(TypeScriptFetchClientCodegen.USE_SQUARE_BRACKETS_IN_ARRAY_NAMES, Boolean.FALSE.toString()) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptNestjsClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptNestjsClientOptionsProvider.java index 8c89e824f241..b7753c347f89 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptNestjsClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptNestjsClientOptionsProvider.java @@ -49,6 +49,7 @@ public class TypeScriptNestjsClientOptionsProvider implements OptionsProvider { public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; public static final String ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_VALUE = "false"; public static final String USE_SINGLE_REQUEST_PARAMETER = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -90,6 +91,7 @@ public Map createOptions() { .put(TypeScriptNestjsClientCodegen.FILE_NAMING, FILE_NAMING_VALUE) .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) .put(CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, USE_SINGLE_REQUEST_PARAMETER) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptNodeClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptNodeClientOptionsProvider.java index fca76c379aef..8da323063988 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptNodeClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptNodeClientOptionsProvider.java @@ -43,6 +43,7 @@ public class TypeScriptNodeClientOptionsProvider implements OptionsProvider { public static final String PREPEND_FORM_OR_BODY_PARAMETERS_VALUE = "true"; public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false"; public static final String ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_VALUE = "false"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -71,6 +72,7 @@ public Map createOptions() { .put(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, "true") .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true") .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE) + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/XojoClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/XojoClientOptionsProvider.java index a7f9a8697658..7e9adb9a1406 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/XojoClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/XojoClientOptionsProvider.java @@ -32,6 +32,7 @@ public class XojoClientOptionsProvider implements OptionsProvider { public static final String SUPPORTS_ASYNC_VALUE = "true"; public static final String API_PACKAGE_VALUE = "APIs"; public static final String MODEL_PACKAGE_VALUE = "Models"; + public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true"; @Override public String getLanguage() { @@ -57,6 +58,7 @@ public Map createOptions() { .put(CodegenConstants.ENSURE_UNIQUE_PARAMS, "true") .put(CodegenConstants.ALLOW_UNICODE_IDENTIFIERS, "false") .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "false") + .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE) .build(); } diff --git a/modules/openapi-generator/src/test/resources/3_0/issue_15274.yaml b/modules/openapi-generator/src/test/resources/3_0/issue_15274.yaml new file mode 100644 index 000000000000..4c07979b0f6f --- /dev/null +++ b/modules/openapi-generator/src/test/resources/3_0/issue_15274.yaml @@ -0,0 +1,87 @@ +openapi: 3.0.0 +info: + title: test + description: >- + test schema + version: 1.0.0 +servers: + - url: 'http://test.com' + description: stage +paths: + /demo: + get: + summary: placeholder summary + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Pet' +components: + schemas: + AllPets: + type: object + properties: + pets: + type: array + items: + $ref: '#/components/schemas/Pet' + Pet: + type: object + required: + - petType + properties: + petType: + $ref: '#/components/schemas/PetType' + oneOf: + - $ref: '#/components/schemas/Cat' + - $ref: '#/components/schemas/Dog' + - $ref: '#/components/schemas/Lizard' + discriminator: + propertyName: petType + mapping: + PET_CAT: '#/components/schemas/Cat' + PET_DOG: '#/components/schemas/Dog' + PET_LIZARD: '#/components/schemas/Lizard' + Cat: + title: PET_CAT + type: object + description: This Pet describes a Cat + properties: + id: + type: string + type_id: + type: string + default: Cat + description: Cat + Dog: + title: PET_DOG + type: object + description: This Pet describes a Dog + properties: + id: + type: string + type_id: + type: string + default: Dog + description: Dog + Lizard: + title: PET_LIZARD + type: object + description: This Pet describes a Lizard + properties: + id: + type: string + type_id: + type: string + default: Lizard + description: Lizard + loves_rocks: + type: boolean + PetType: + type: string + enum: + - PET_CAT + - PET_DOG + - PET_LIZARD \ No newline at end of file