fix(Kotlin): use the global apiNamePrefix and apiNameSuffix settings (#23822)

bin/configs/typescript-consolidated-browser.yaml

@@ -8,3 +8,4 @@ additionalProperties:
   projectName: ts-petstore-client
   moduleName: petstore
   supportsES6: true
+  enumType: stringUnion

bin/configs/typescript-consolidated-deno.yaml

@@ -7,3 +7,4 @@ additionalProperties:
   npmName: ts-petstore-client
   projectName: ts-petstore-client
   moduleName: petstore
+  enumType: stringUnion

bin/configs/typescript-consolidated-jquery.yaml

@@ -7,3 +7,4 @@ additionalProperties:
   npmName: ts-petstore-client
   projectName: ts-petstore-client
   moduleName: petstore
+  enumType: stringUnion

bin/configs/typescript-consolidated-node-object-parameters.yaml

@@ -8,3 +8,4 @@ additionalProperties:
   useObjectParameters: true
   projectName: ts-petstore-client
   moduleName: petstore
+  enumType: stringUnion

docs/generators/kotlin-server.md

@@ -19,7 +19,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | Option | Description | Values | Default |
 | ------ | ----------- | ------ | ------- |
 |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
-|apiSuffix|suffix for api classes| |Api|
 |artifactId|Generated artifact id (name of jar).| |kotlin-server|
 |artifactVersion|Generated artifact's package version.| |1.0.0|
 |enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|

docs/generators/kotlin-spring.md

@@ -21,7 +21,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
 |annotationLibrary|Select the complementary documentation annotation library.|<dl><dt>**none**</dt><dd>Do not annotate Model and Api with complementary annotations.</dd><dt>**swagger1**</dt><dd>Annotate Model and Api using the Swagger Annotations 1.x library.</dd><dt>**swagger2**</dt><dd>Annotate Model and Api using the Swagger Annotations 2.x library.</dd></dl>|swagger2|
 |apiPackage|api package for generated code| |org.openapitools.api|
-|apiSuffix|suffix for api classes| |Api|
 |appendRequestToHandler|Append ServerHttpRequest to handler method for getting request stuff| |false|
 |artifactId|Generated artifact id (name of jar).| |openapi-spring|
 |artifactVersion|Generated artifact's package version.| |1.0.0|

docs/generators/kotlin-vertx.md

@@ -19,7 +19,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | Option | Description | Values | Default |
 | ------ | ----------- | ------ | ------- |
 |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
-|apiSuffix|suffix for api classes| |Api|
 |artifactId|Generated artifact id (name of jar).| |null|
 |artifactVersion|Generated artifact's package version.| |1.0.0|
 |enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|

docs/generators/kotlin-wiremock.md

@@ -19,7 +19,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | Option | Description | Values | Default |
 | ------ | ----------- | ------ | ------- |
 |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
-|apiSuffix|suffix for api classes| |Api|
 |artifactId|Generated artifact id (name of jar).| |null|
 |artifactVersion|Generated artifact's package version.| |1.0.0|
 |enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|

docs/generators/kotlin.md

@@ -19,7 +19,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | Option | Description | Values | Default |
 | ------ | ----------- | ------ | ------- |
 |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
-|apiSuffix|suffix for api classes| |Api|
 |artifactId|Generated artifact id (name of jar).| |kotlin-client|
 |artifactVersion|Generated artifact's package version.| |1.0.0|
 |collectionType|Option. Collection type to use|<dl><dt>**array**</dt><dd>kotlin.Array</dd><dt>**list**</dt><dd>kotlin.collections.List</dd></dl>|list|

docs/generators/typescript.md

@@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |enumNameSuffix|Suffix that will be appended to all enum names.| |Enum|
 |enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |PascalCase|
 |enumPropertyNamingReplaceSpecialChar|Set to true to replace '-' and '+' symbols with 'minus_' and 'plus_' in enum of type string| |false|
+|enumType|Specify the enum type which should be used in the client code.|<dl><dt>**stringUnion**</dt><dd>Union of literal string types</dd><dt>**enum**</dt><dd>Typescript's [string enums](https://www.typescriptlang.org/docs/handbook/enums.html#string-enums)</dd></dl>|enum|
 |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.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>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.</dd></dl>|false|
 |fileContentDataType|Specifies the type to use for the content of a file - i.e. Blob (Browser, Deno) / Buffer (node)| |Buffer|
 |framework|Specify the framework which should be used in the client code.|<dl><dt>**fetch-api**</dt><dd>fetch-api</dd><dt>**jquery**</dt><dd>jquery</dd></dl>|fetch-api|

modules/openapi-generator-cli/pom.xml

@@ -4,7 +4,7 @@
         <groupId>org.openapitools</groupId>
         <artifactId>openapi-generator-project</artifactId>
         <!-- RELEASE_VERSION -->
-        <version>7.8.0-SNAPSHOT</version>
+        <version>8.0.0-SNAPSHOT</version>
         <!-- /RELEASE_VERSION -->
         <relativePath>../../pom.xml</relativePath>
     </parent>

modules/openapi-generator-core/pom.xml

@@ -6,7 +6,7 @@
     <artifactId>openapi-generator-project</artifactId>
     <groupId>org.openapitools</groupId>
     <!-- RELEASE_VERSION -->
-    <version>7.8.0-SNAPSHOT</version>
+    <version>8.0.0-SNAPSHOT</version>
     <!-- /RELEASE_VERSION -->
     <relativePath>../../pom.xml</relativePath>
   </parent>

modules/openapi-generator-gradle-plugin/gradle.properties

@@ -1,5 +1,5 @@
 # RELEASE_VERSION
-openApiGeneratorVersion=7.8.0-SNAPSHOT
+openApiGeneratorVersion=8.0.0-SNAPSHOT
 # /RELEASE_VERSION
 
 # BEGIN placeholders

modules/openapi-generator-gradle-plugin/pom.xml

@@ -4,7 +4,7 @@
         <groupId>org.openapitools</groupId>
         <artifactId>openapi-generator-project</artifactId>
         <!-- RELEASE_VERSION -->
-        <version>7.8.0-SNAPSHOT</version>
+        <version>8.0.0-SNAPSHOT</version>
         <!-- /RELEASE_VERSION -->
         <relativePath>../../pom.xml</relativePath>
     </parent>

modules/openapi-generator-gradle-plugin/samples/local-spec/gradle.properties

@@ -1,3 +1,3 @@
 # RELEASE_VERSION
-openApiGeneratorVersion=7.8.0-SNAPSHOT
+openApiGeneratorVersion=8.0.0-SNAPSHOT
 # /RELEASE_VERSION

modules/openapi-generator-maven-plugin/examples/java-client.xml

@@ -13,7 +13,7 @@
                 <groupId>org.openapitools</groupId>
                 <artifactId>openapi-generator-maven-plugin</artifactId>
                 <!-- RELEASE_VERSION -->
-                <version>7.8.0-SNAPSHOT</version>
+                <version>8.0.0-SNAPSHOT</version>
                 <!-- /RELEASE_VERSION -->
                 <executions>
                     <execution>

modules/openapi-generator-maven-plugin/examples/kotlin.xml

@@ -15,7 +15,7 @@
 				<groupId>org.openapitools</groupId>
 				<artifactId>openapi-generator-maven-plugin</artifactId>
 				<!-- RELEASE_VERSION -->
-				<version>7.8.0-SNAPSHOT</version>
+				<version>8.0.0-SNAPSHOT</version>
 				<!-- /RELEASE_VERSION -->
 				<executions>
 					<execution>

modules/openapi-generator-maven-plugin/examples/multi-module/java-client/pom.xml

@@ -19,7 +19,7 @@
                 <groupId>org.openapitools</groupId>
                 <artifactId>openapi-generator-maven-plugin</artifactId>
                 <!-- RELEASE_VERSION -->
-                <version>7.8.0-SNAPSHOT</version>
+                <version>8.0.0-SNAPSHOT</version>
                 <!-- /RELEASE_VERSION -->
                 <dependencies>
                     <dependency>

modules/openapi-generator-maven-plugin/examples/non-java-invalid-spec.xml

@@ -13,7 +13,7 @@
                 <groupId>org.openapitools</groupId>
                 <artifactId>openapi-generator-maven-plugin</artifactId>
                 <!-- RELEASE_VERSION -->
-                <version>7.8.0-SNAPSHOT</version>
+                <version>8.0.0-SNAPSHOT</version>
                 <!-- /RELEASE_VERSION -->
                 <executions>
                     <execution>

modules/openapi-generator-maven-plugin/examples/non-java.xml

@@ -13,7 +13,7 @@
                 <groupId>org.openapitools</groupId>
                 <artifactId>openapi-generator-maven-plugin</artifactId>
                 <!-- RELEASE_VERSION -->
-                <version>7.8.0-SNAPSHOT</version>
+                <version>8.0.0-SNAPSHOT</version>
                 <!-- /RELEASE_VERSION -->
                 <executions>
                     <execution>

modules/openapi-generator-maven-plugin/examples/spring.xml

@@ -20,7 +20,7 @@
                 <groupId>org.openapitools</groupId>
                 <artifactId>openapi-generator-maven-plugin</artifactId>
                 <!-- RELEASE_VERSION -->
-                <version>7.8.0-SNAPSHOT</version>
+                <version>8.0.0-SNAPSHOT</version>
                 <!-- /RELEASE_VERSION -->
                 <executions>
                     <execution>

modules/openapi-generator-maven-plugin/pom.xml

@@ -5,7 +5,7 @@
         <groupId>org.openapitools</groupId>
         <artifactId>openapi-generator-project</artifactId>
         <!-- RELEASE_VERSION -->
-        <version>7.8.0-SNAPSHOT</version>
+        <version>8.0.0-SNAPSHOT</version>
         <!-- /RELEASE_VERSION -->
         <relativePath>../../pom.xml</relativePath>
     </parent>

modules/openapi-generator-online/pom.xml

@@ -4,7 +4,7 @@
         <groupId>org.openapitools</groupId>
         <artifactId>openapi-generator-project</artifactId>
         <!-- RELEASE_VERSION -->
-        <version>7.8.0-SNAPSHOT</version>
+        <version>8.0.0-SNAPSHOT</version>
         <!-- /RELEASE_VERSION -->
         <relativePath>../../pom.xml</relativePath>
     </parent>

modules/openapi-generator/pom.xml

@@ -4,7 +4,7 @@
         <groupId>org.openapitools</groupId>
         <artifactId>openapi-generator-project</artifactId>
         <!-- RELEASE_VERSION -->
-        <version>7.8.0-SNAPSHOT</version>
+        <version>8.0.0-SNAPSHOT</version>
         <!-- /RELEASE_VERSION -->
         <relativePath>../../pom.xml</relativePath>
     </parent>

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractKotlinCodegen.java

@@ -60,7 +60,6 @@ public abstract class AbstractKotlinCodegen extends DefaultCodegen implements Co
     @Setter protected String artifactVersion = "1.0.0";
     @Setter protected String groupId = "org.openapitools";
     @Setter protected String packageName = "org.openapitools";
-    @Setter protected String apiSuffix = "Api";
 
     @Setter protected String sourceFolder = "src/main/kotlin";
     @Setter protected String testFolder = "src/test/kotlin";
@@ -253,7 +252,6 @@ public AbstractKotlinCodegen() {
         cliOptions.clear();
         addOption(CodegenConstants.SOURCE_FOLDER, CodegenConstants.SOURCE_FOLDER_DESC, sourceFolder);
         addOption(CodegenConstants.PACKAGE_NAME, "Generated artifact package name.", packageName);
-        addOption(CodegenConstants.API_SUFFIX, CodegenConstants.API_SUFFIX_DESC, apiSuffix);
         addOption(CodegenConstants.GROUP_ID, "Generated artifact package's organization (i.e. maven groupId).", groupId);
         addOption(CodegenConstants.ARTIFACT_ID, "Generated artifact id (name of jar).", artifactId);
         addOption(CodegenConstants.ARTIFACT_VERSION, "Generated artifact's package version.", artifactVersion);
@@ -458,10 +456,6 @@ public void processOpts() {
             additionalProperties.put(CodegenConstants.PACKAGE_NAME, packageName);
         }
 
-        if (additionalProperties.containsKey(CodegenConstants.API_SUFFIX)) {
-            this.setApiSuffix((String) additionalProperties.get(CodegenConstants.API_SUFFIX));
-        }
-
         if (additionalProperties.containsKey(CodegenConstants.ARTIFACT_ID)) {
             this.setArtifactId((String) additionalProperties.get(CodegenConstants.ARTIFACT_ID));
         } else {
@@ -615,7 +609,7 @@ public String toApiName(String name) {
         if (name.length() == 0) {
             return "DefaultApi";
         }
-        return (this.apiSuffix.isEmpty() ? camelize(name) : camelize(name) + this.apiSuffix);
+        return this.apiNamePrefix + camelize(name) + this.apiNameSuffix;
     }
 
     /**

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptClientCodegen.java

@@ -75,6 +75,9 @@ public class TypeScriptClientCodegen extends AbstractTypeScriptClientCodegen imp
 
     private static final String USE_OBJECT_PARAMS_SWITCH = "useObjectParameters";
     private static final String USE_OBJECT_PARAMS_DESC = "Use aggregate parameter objects as function arguments for api operations instead of passing each parameter as a separate function argument.";
+    private static final String ENUM_TYPE_SWITCH = "enumType";
+    private static final String ENUM_TYPE_SWITCH_DESC = "Specify the enum type which should be used in the client code.";
+    private static final String[][] ENUM_TYPES = {{"stringUnion", "Union of literal string types"}, {"enum", "Typescript's [string enums](https://www.typescriptlang.org/docs/handbook/enums.html#string-enums)"}};
 
     private final Map<String, String> frameworkToHttpLibMap;
 
@@ -137,6 +140,13 @@ public TypeScriptClientCodegen() {
 
         cliOptions.add(platformOption);
 
+        CliOption enumTypeOption = new CliOption(TypeScriptClientCodegen.ENUM_TYPE_SWITCH, TypeScriptClientCodegen.ENUM_TYPE_SWITCH_DESC);
+        for (String[] option : TypeScriptClientCodegen.ENUM_TYPES) {
+            enumTypeOption.addEnum(option[0], option[1]);
+        }
+        enumTypeOption.defaultValue(ENUM_TYPES[1][0]);
+        cliOptions.add(enumTypeOption);
+
         // Set property naming to camelCase
         supportModelPropertyNaming(CodegenConstants.MODEL_PROPERTY_NAMING_TYPE.camelCase);
 
@@ -404,6 +414,15 @@ public void processOpts() {
                 "http", httpLibName + ".ts"
         ));
 
+        additionalProperties.putIfAbsent(ENUM_TYPE_SWITCH, ENUM_TYPES[1][0]);
+        Object propEnumType = additionalProperties.get(ENUM_TYPE_SWITCH);
+
+        Map<String, Boolean> enumTypes = new HashMap<>();
+        for (String[] option : ENUM_TYPES) {
+            enumTypes.put(option[0], option[0].equals(propEnumType));
+        }
+        additionalProperties.put("enumTypes", enumTypes);
+
         Object propPlatform = additionalProperties.get(PLATFORM_SWITCH);
         if (propPlatform == null) {
             propPlatform = "browser";

modules/openapi-generator/src/main/resources/typescript/model/model.mustache

@@ -71,26 +71,40 @@ export class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{
 
 {{#vars}}
 {{#isEnum}}
+{{#enumTypes}}
+{{#enum}}
 export enum {{classname}}{{enumName}} {
     {{#allowableValues}}
     {{#enumVars}}
     {{name}} = {{{value}}}{{^-last}},{{/-last}}
     {{/enumVars}}
     {{/allowableValues}}
 }
+{{/enum}}
+{{#stringUnion}}
+    export type {{classname}}{{enumName}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
+{{/stringUnion}}
+{{/enumTypes}}
 {{/isEnum}}
 {{/vars}}
 
 {{/hasEnums}}
 {{/isEnum}}
 {{#isEnum}}
+{{#enumTypes}}
+{{#enum}}
 export enum {{classname}} {
     {{#allowableValues}}
     {{#enumVars}}
     {{name}} = {{{value}}}{{^-last}},{{/-last}}
     {{/enumVars}}
     {{/allowableValues}}
 }
+{{/enum}}
+{{#stringUnion}}
+    export type {{classname}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
+{{/stringUnion}}
+{{/enumTypes}}
 {{/isEnum}}
 {{/model}}
 {{/models}}

modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/AbstractKotlinCodegenTest.java

@@ -154,11 +154,26 @@ public void convertApiNameWithEmptySuffix() {
 
     @Test
     public void convertApiNameWithSuffix() {
-        codegen.setApiSuffix("Test");
+        codegen.setApiNameSuffix("Test");
         assertEquals(codegen.toApiName("Fake"), "FakeTest");
         assertEquals(codegen.toApiName(""), "DefaultApi");
     }
 
+    @Test
+    public void convertApiNameWithPrefix() {
+        codegen.setApiNamePrefix("Prefix");
+        assertEquals(codegen.toApiName("Fake"), "PrefixFakeApi");
+        assertEquals(codegen.toApiName(""), "DefaultApi");
+    }
+
+    @Test
+    public void convertApiNameWithPrefixAndSuffix() {
+        codegen.setApiNamePrefix("Prefix");
+        codegen.setApiNameSuffix("Suffix");
+        assertEquals(codegen.toApiName("Fake"), "PrefixFakeSuffix");
+        assertEquals(codegen.toApiName(""), "DefaultApi");
+    }
+
     @Test
     public void apIFileFolder() {
         codegen.setOutputDir("/User/open/api/tools");

pom.xml

@@ -15,7 +15,7 @@
     <packaging>pom</packaging>
     <name>openapi-generator-project</name>
     <!-- RELEASE_VERSION -->
-    <version>7.8.0-SNAPSHOT</version>
+    <version>8.0.0-SNAPSHOT</version>
     <!-- /RELEASE_VERSION -->
     <url>https://github.com/openapitools/openapi-generator</url>
     <scm>

samples/client/echo_api/csharp-restsharp/.openapi-generator/VERSION

@@ -1 +1 @@
-7.8.0-SNAPSHOT
+8.0.0-SNAPSHOT

samples/client/echo_api/csharp-restsharp/README.md

@@ -6,7 +6,7 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
 
 - API version: 0.1.0
 - SDK version: 1.0.0
-- Generator version: 7.8.0-SNAPSHOT
+- Generator version: 8.0.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.CSharpClientCodegen
 
 <a id="frameworks-supported"></a>

samples/client/echo_api/go-external-refs/.openapi-generator/VERSION

@@ -1 +1 @@
-7.8.0-SNAPSHOT
+8.0.0-SNAPSHOT

samples/client/echo_api/go-external-refs/README.md

@@ -7,7 +7,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
 
 - API version: 0.1.0
 - Package version: 1.0.0
-- Generator version: 7.8.0-SNAPSHOT
+- Generator version: 8.0.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.GoClientCodegen
 
 ## Installation

samples/client/echo_api/go/.openapi-generator/VERSION

@@ -1 +1 @@
-7.8.0-SNAPSHOT
+8.0.0-SNAPSHOT

samples/client/echo_api/go/README.md

@@ -7,7 +7,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
 
 - API version: 0.1.0
 - Package version: 1.0.0
-- Generator version: 7.8.0-SNAPSHOT
+- Generator version: 8.0.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.GoClientCodegen
 
 ## Installation

samples/client/echo_api/java/apache-httpclient/.openapi-generator/VERSION

@@ -1 +1 @@
-7.8.0-SNAPSHOT
+8.0.0-SNAPSHOT

samples/client/echo_api/java/apache-httpclient/README.md

@@ -4,7 +4,7 @@ Echo Server API
 
 - API version: 0.1.0
 
-- Generator version: 7.8.0-SNAPSHOT
+- Generator version: 8.0.0-SNAPSHOT
 
 Echo Server API
 

samples/client/echo_api/java/apache-httpclient/src/main/java/org/openapitools/client/ApiClient.java

@@ -81,7 +81,7 @@
 import org.openapitools.client.auth.HttpBasicAuth;
 import org.openapitools.client.auth.HttpBearerAuth;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0-SNAPSHOT")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 8.0.0-SNAPSHOT")
 public class ApiClient extends JavaTimeFormatter {
   private Map<String, String> defaultHeaderMap = new HashMap<String, String>();
   private Map<String, String> defaultCookieMap = new HashMap<String, String>();