[kotlin] Enum should match spec

docs/generators/kotlin-server.md

@@ -22,7 +22,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |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'| |camelCase|
+|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|
 |featureAutoHead|Automatically provide responses to HEAD requests for existing routes that have the GET verb defined.| |true|
 |featureCORS|Ktor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org.| |false|
 |featureCompression|Adds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response.| |true|

docs/generators/kotlin-spring.md

@@ -30,7 +30,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |configPackage|configuration package for generated code| |org.openapitools.configuration|
 |delegatePattern|Whether to generate the server files using the delegate pattern| |false|
 |documentationProvider|Select the OpenAPI documentation provider.|<dl><dt>**none**</dt><dd>Do not publish an OpenAPI specification.</dd><dt>**source**</dt><dd>Publish the original input OpenAPI specification.</dd><dt>**springfox**</dt><dd>Generate an OpenAPI 2 (fka Swagger RESTful API Documentation Specification) specification using SpringFox 2.x. Deprecated (for removal); use springdoc instead.</dd><dt>**springdoc**</dt><dd>Generate an OpenAPI 3 specification using SpringDoc.</dd></dl>|springdoc|
-|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase|
+|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|
 |exceptionHandler|generate default global exception handlers (not compatible with reactive. enabling reactive will disable exceptionHandler )| |true|
 |gradleBuildFile|generate a gradle build file using the Kotlin DSL| |true|
 |groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|

docs/generators/kotlin-vertx.md

@@ -22,7 +22,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |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'| |camelCase|
+|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|
 |groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
 |modelMutable|Create mutable models| |false|
 |packageName|Generated artifact package name.| |org.openapitools|

docs/generators/kotlin.md

@@ -24,7 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |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|
 |dateLibrary|Option. Date library to use|<dl><dt>**threetenbp-localdatetime**</dt><dd>Threetenbp - Backport of JSR310 (jvm only, for legacy app only)</dd><dt>**kotlinx-datetime**</dt><dd>kotlinx-datetime (preferred for multiplatform)</dd><dt>**string**</dt><dd>String</dd><dt>**java8-localdatetime**</dt><dd>Java 8 native JSR310 (jvm only, for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (jvm only, preferred for jdk 1.8+)</dd><dt>**threetenbp**</dt><dd>Threetenbp - Backport of JSR310 (jvm only, preferred for jdk &lt; 1.8)</dd></dl>|java8|
-|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase|
+|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|
 |generateRoomModels|Generate Android Room database models in addition to API models (JVM Volley library only)| |false|
 |groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
 |idea|Add IntellJ Idea plugin and mark Kotlin main and test folders as source folders.| |false|

docs/generators/ktorm-schema.md

@@ -23,7 +23,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |artifactId|Generated artifact id (name of jar).| |ktorm|
 |artifactVersion|Generated artifact's package version.| |1.0.0|
 |defaultDatabaseName|Default database name for all queries| |sqlite.db|
-|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase|
+|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|
 |groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
 |identifierNamingConvention|Naming convention of Ktorm identifiers(table names and column names). This is not related to database name which is defined by defaultDatabaseName option|<dl><dt>**original**</dt><dd>Do not transform original names</dd><dt>**snake_case**</dt><dd>Use snake_case names</dd></dl>|original|
 |importModelPackageName|Package name of the imported models| |org.openapitools.database.models|

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

@@ -76,7 +76,7 @@ public abstract class AbstractKotlinCodegen extends DefaultCodegen implements Co
 
     protected boolean nonPublicApi = false;
 
-    protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE enumPropertyNaming = CodegenConstants.ENUM_PROPERTY_NAMING_TYPE.camelCase;
+    protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE enumPropertyNaming = CodegenConstants.ENUM_PROPERTY_NAMING_TYPE.original;
 
     // model classes cannot use the same property names defined in HashMap
     // ref: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-hash-map/

modules/openapi-generator/src/main/resources/asciidoc-documentation/model.mustache

@@ -9,20 +9,38 @@
 
 {{unescapedDescription}}
 
+
+{{^allowableValues}}
 [.fields-{{classname}}]
-[cols="2,1,2,4,1"]
+[cols="2,1,1,2,4,1"]
 |===
-| Field Name| Required| Type| Description| Format
+| Field Name| Required| Nullable | Type| Description | Format
 
 {{#vars}}
 | {{baseName}}
 | {{#required}}X{{/required}}
-| {{dataType}} {{#isContainer}} of <<{{complexType}}>>{{/isContainer}}
+| {{#isNullable}}X{{/isNullable}}
+| {{#isModel}}<<{{ dataType }}>>{{/isModel}} {{^container}}{{^allowableValues}} {{^isModel}}{{ dataType }}{{/isModel}}{{/allowableValues}}{{#allowableValues}}{{^allowableValues.empty}}<<{{ dataType }}>>{{/allowableValues.empty}}{{/allowableValues}} {{/container}} {{#isContainer}} of <<{{complexType}}>>{{/isContainer}}
 | {{description}}
-| {{{dataFormat}}} {{#isEnum}}_Enum:_ {{#_enum}}{{this}}, {{/_enum}}{{/isEnum}}
+| {{{dataFormat}}} {{#isEnum}}_Enum:_ {{#_enum}}{{this}}, {{/_enum}}{{/isEnum}} {{^isEnum}}{{^container}}{{^allowableValues.empty}} {{#allowableValues.values}}{{this}}, {{/allowableValues.values}} {{/allowableValues.empty}}{{/container}}{{/isEnum}}
 
 {{/vars}}
 |===
+{{/allowableValues}}
+
+{{#allowableValues}}
+
+[.fields-{{classname}}]
+[cols="1"]
+|===
+| Enum Values
+
+{{#allowableValues.values}}
+| {{this}}
+{{/allowableValues.values}}
+
+|===
+{{/allowableValues}}
 
     {{/model}}
 {{/models}}

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

@@ -16,6 +16,9 @@
 import org.testng.annotations.Test;
 
 import java.io.File;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -278,9 +281,70 @@ public void testEnumPropertyWithDefaultValue() {
         // Assert the enum default value is properly generated
         CodegenProperty cp1 = cm1.vars.get(0);
         Assert.assertEquals(cp1.getEnumName(), "PropertyName");
-        Assert.assertEquals(cp1.getDefaultValue(), "PropertyName.vALUE");
+        Assert.assertEquals(cp1.getDefaultValue(), "PropertyName.VALUE");
     }
 
+    @Test(description = "Issue #3804")
+    public void testEnumPropertyWithCapitalization() {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/kotlin/issue3804-enum-enum-capitalization.yaml");
+        final AbstractKotlinCodegen codegen = new P_AbstractKotlinCodegen();
+
+        Schema test1 = openAPI.getComponents().getSchemas().get("ModelWithEnumPropertyHavingDefault");
+        CodegenModel cm1 = codegen.fromModel("ModelWithEnumPropertyHavingDefault", test1);
+
+        // We need to postProcess the model for enums to be processed
+        codegen.postProcessModels(createCodegenModelWrapper(cm1));
+
+        // Assert the enums are generated without changing capitalization
+        CodegenProperty cp0 = cm1.vars.get(0);
+        Assert.assertEquals(cp0.getEnumName(), "PropertyName");
+        Assert.assertEquals(((HashMap)((ArrayList) cp0.getAllowableValues().get("enumVars")).get(0)).get("name"), "VALUE");
+        CodegenProperty cp1 = cm1.vars.get(1);
+        Assert.assertEquals(cp1.getEnumName(), "PropertyName2");
+        Assert.assertEquals(((HashMap)((ArrayList) cp1.getAllowableValues().get("enumVars")).get(0)).get("name"), "Value");
+        CodegenProperty cp2 = cm1.vars.get(2);
+        Assert.assertEquals(cp2.getEnumName(), "PropertyName3");
+        Assert.assertEquals(((HashMap)((ArrayList) cp2.getAllowableValues().get("enumVars")).get(0)).get("name"), "nonkeywordvalue");
+    }
+
+    @Test(description = "Issue #3804")
+    public void testEnumPropertyDefaultWithCapitalization() {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/kotlin/issue3804-enum-enum-capitalization.yaml");
+        final AbstractKotlinCodegen codegen = new P_AbstractKotlinCodegen();
+
+        Schema test1 = openAPI.getComponents().getSchemas().get("ModelWithEnumPropertyHavingDefault");
+        CodegenModel cm1 = codegen.fromModel("ModelWithEnumPropertyHavingDefault", test1);
+
+        // We need to postProcess the model for enums to be processed
+        codegen.postProcessModels(createCodegenModelWrapper(cm1));
+
+        // Assert the enum default value is properly generated
+        CodegenProperty cp0 = cm1.vars.get(0);
+        Assert.assertEquals(cp0.getDefaultValue(), "PropertyName.VALUE");
+        CodegenProperty cp1 = cm1.vars.get(1);
+        Assert.assertEquals(cp1.getDefaultValue(), "PropertyName2.Value");
+        CodegenProperty cp2 = cm1.vars.get(2);
+        Assert.assertEquals(cp2.getDefaultValue(), "PropertyName3.nonkeywordvalue");
+    }
+
+    @Test(description = "Issue #3804")
+    public void testEnumPropertyWithKeyword() {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/kotlin/issue3804-enum-enum-capitalization.yaml");
+        final AbstractKotlinCodegen codegen = new P_AbstractKotlinCodegen();
+
+        Schema test1 = openAPI.getComponents().getSchemas().get("ModelWithEnumPropertyHavingDefault");
+        CodegenModel cm1 = codegen.fromModel("ModelWithEnumPropertyHavingDefault", test1);
+
+        // We need to postProcess the model for enums to be processed
+        codegen.postProcessModels(createCodegenModelWrapper(cm1));
+
+        // Assert the enum default value is properly generated
+        CodegenProperty cp3 = cm1.vars.get(3);
+        Assert.assertEquals(cp3.getEnumName(), "PropertyName4");
+        Assert.assertEquals(cp3.getDefaultValue(), "PropertyName4.`value`");
+    }
+
+
     @Test(description = "Issue #10792")
     public void handleInheritanceWithObjectTypeShouldNotBeAMap() {
         Schema parent = new ObjectSchema()

modules/openapi-generator/src/test/resources/3_0/asciidoc/api-docs.json

@@ -1399,9 +1399,21 @@
                         "items": {
                             "$ref": "#/components/schemas/TaskWeek"
                         }
+                    },
+                    "pricingModelType":{
+                        "$ref": "#/components/schemas/PricingModelType"
                     }
                 },
                 "description": "week, holds all work and working assignments."
+            },
+            "PricingModelType": {
+                "type": "string",
+                "enum": [
+                    "Unsupported",
+                    "Flex",
+                    "Community",
+                    "Freedom"
+                ]
             }
         },
         "securitySchemes": {

modules/openapi-generator/src/test/resources/3_0/kotlin/issue3804-enum-enum-capitalization.yaml

@@ -0,0 +1,41 @@
+openapi: 3.0.0
+info:
+  title: 'Issue 10591 Enum default value'
+  version: latest
+paths:
+  '/':
+    get:
+      operationId: operation
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ModelWithEnumPropertyHavingDefault'
+components:
+  schemas:
+    ModelWithEnumPropertyHavingDefault:
+      required:
+        - propertyName
+      properties:
+        propertyName:
+          type: string
+          default: VALUE
+          enum:
+            - VALUE
+        propertyName2:
+          type: string
+          default: Value
+          enum:
+            - Value
+        propertyName3:
+          type: string
+          default: nonkeywordvalue
+          enum:
+            - nonkeywordvalue
+        propertyName4:
+          type: string
+          default: value
+          enum:
+            - value

samples/client/echo_api/kotlin-jvm-spring-3-restclient/docs/StringEnumRef.md

@@ -10,7 +10,7 @@
 
     * `unclassified` (value: `"unclassified"`)
 
-    * `unknownDefaultOpenApi` (value: `"unknown_default_open_api"`)
+    * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 
 

samples/client/echo_api/kotlin-jvm-spring-3-restclient/src/main/kotlin/org/openapitools/client/models/DefaultValue.kt

@@ -65,13 +65,13 @@ data class DefaultValue (
     /**
      * 
      *
-     * Values: success,failure,unclassified,unknownDefaultOpenApi
+     * Values: success,failure,unclassified,unknown_default_open_api
      */
     enum class ArrayStringEnumDefault(val value: kotlin.String) {
         @JsonProperty(value = "success") success("success"),
         @JsonProperty(value = "failure") failure("failure"),
         @JsonProperty(value = "unclassified") unclassified("unclassified"),
-        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknownDefaultOpenApi("unknown_default_open_api");
+        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknown_default_open_api("unknown_default_open_api");
     }
 }
 

samples/client/echo_api/kotlin-jvm-spring-3-restclient/src/main/kotlin/org/openapitools/client/models/Pet.kt

@@ -59,13 +59,13 @@ data class Pet (
     /**
      * pet status in the store
      *
-     * Values: available,pending,sold,unknownDefaultOpenApi
+     * Values: available,pending,sold,unknown_default_open_api
      */
     enum class Status(val value: kotlin.String) {
         @JsonProperty(value = "available") available("available"),
         @JsonProperty(value = "pending") pending("pending"),
         @JsonProperty(value = "sold") sold("sold"),
-        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknownDefaultOpenApi("unknown_default_open_api");
+        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknown_default_open_api("unknown_default_open_api");
     }
 }
 

samples/client/echo_api/kotlin-jvm-spring-3-restclient/src/main/kotlin/org/openapitools/client/models/Query.kt

@@ -41,13 +41,13 @@ data class Query (
     /**
      * 
      *
-     * Values: sUCCESS,fAILURE,sKIPPED,unknownDefaultOpenApi
+     * Values: SUCCESS,FAILURE,SKIPPED,unknown_default_open_api
      */
     enum class Outcomes(val value: kotlin.String) {
-        @JsonProperty(value = "SUCCESS") sUCCESS("SUCCESS"),
-        @JsonProperty(value = "FAILURE") fAILURE("FAILURE"),
-        @JsonProperty(value = "SKIPPED") sKIPPED("SKIPPED"),
-        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknownDefaultOpenApi("unknown_default_open_api");
+        @JsonProperty(value = "SUCCESS") SUCCESS("SUCCESS"),
+        @JsonProperty(value = "FAILURE") FAILURE("FAILURE"),
+        @JsonProperty(value = "SKIPPED") SKIPPED("SKIPPED"),
+        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknown_default_open_api("unknown_default_open_api");
     }
 }
 

samples/client/echo_api/kotlin-jvm-spring-3-restclient/src/main/kotlin/org/openapitools/client/models/StringEnumRef.kt

@@ -21,7 +21,7 @@ import com.fasterxml.jackson.annotation.JsonProperty
 /**
  * 
  *
- * Values: success,failure,unclassified,unknownDefaultOpenApi
+ * Values: success,failure,unclassified,unknown_default_open_api
  */
 
 enum class StringEnumRef(val value: kotlin.String) {
@@ -36,7 +36,7 @@ enum class StringEnumRef(val value: kotlin.String) {
     unclassified("unclassified"),
 
     @JsonProperty(value = "unknown_default_open_api")
-    unknownDefaultOpenApi("unknown_default_open_api");
+    unknown_default_open_api("unknown_default_open_api");
 
     /**
      * Override [toString()] to avoid using the enum variable name as the value, and instead use

samples/client/echo_api/kotlin-jvm-spring-3-webclient/docs/StringEnumRef.md

@@ -10,7 +10,7 @@
 
     * `unclassified` (value: `"unclassified"`)
 
-    * `unknownDefaultOpenApi` (value: `"unknown_default_open_api"`)
+    * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 
 

samples/client/echo_api/kotlin-jvm-spring-3-webclient/src/main/kotlin/org/openapitools/client/models/DefaultValue.kt

@@ -65,13 +65,13 @@ data class DefaultValue (
     /**
      * 
      *
-     * Values: success,failure,unclassified,unknownDefaultOpenApi
+     * Values: success,failure,unclassified,unknown_default_open_api
      */
     enum class ArrayStringEnumDefault(val value: kotlin.String) {
         @JsonProperty(value = "success") success("success"),
         @JsonProperty(value = "failure") failure("failure"),
         @JsonProperty(value = "unclassified") unclassified("unclassified"),
-        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknownDefaultOpenApi("unknown_default_open_api");
+        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknown_default_open_api("unknown_default_open_api");
     }
 }
 

samples/client/echo_api/kotlin-jvm-spring-3-webclient/src/main/kotlin/org/openapitools/client/models/Pet.kt

@@ -59,13 +59,13 @@ data class Pet (
     /**
      * pet status in the store
      *
-     * Values: available,pending,sold,unknownDefaultOpenApi
+     * Values: available,pending,sold,unknown_default_open_api
      */
     enum class Status(val value: kotlin.String) {
         @JsonProperty(value = "available") available("available"),
         @JsonProperty(value = "pending") pending("pending"),
         @JsonProperty(value = "sold") sold("sold"),
-        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknownDefaultOpenApi("unknown_default_open_api");
+        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknown_default_open_api("unknown_default_open_api");
     }
 }
 

samples/client/echo_api/kotlin-jvm-spring-3-webclient/src/main/kotlin/org/openapitools/client/models/Query.kt

@@ -41,13 +41,13 @@ data class Query (
     /**
      * 
      *
-     * Values: sUCCESS,fAILURE,sKIPPED,unknownDefaultOpenApi
+     * Values: SUCCESS,FAILURE,SKIPPED,unknown_default_open_api
      */
     enum class Outcomes(val value: kotlin.String) {
-        @JsonProperty(value = "SUCCESS") sUCCESS("SUCCESS"),
-        @JsonProperty(value = "FAILURE") fAILURE("FAILURE"),
-        @JsonProperty(value = "SKIPPED") sKIPPED("SKIPPED"),
-        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknownDefaultOpenApi("unknown_default_open_api");
+        @JsonProperty(value = "SUCCESS") SUCCESS("SUCCESS"),
+        @JsonProperty(value = "FAILURE") FAILURE("FAILURE"),
+        @JsonProperty(value = "SKIPPED") SKIPPED("SKIPPED"),
+        @JsonProperty(value = "unknown_default_open_api") @JsonEnumDefaultValue unknown_default_open_api("unknown_default_open_api");
     }
 }
 

samples/client/echo_api/kotlin-jvm-spring-3-webclient/src/main/kotlin/org/openapitools/client/models/StringEnumRef.kt

@@ -21,7 +21,7 @@ import com.fasterxml.jackson.annotation.JsonProperty
 /**
  * 
  *
- * Values: success,failure,unclassified,unknownDefaultOpenApi
+ * Values: success,failure,unclassified,unknown_default_open_api
  */
 
 enum class StringEnumRef(val value: kotlin.String) {
@@ -36,7 +36,7 @@ enum class StringEnumRef(val value: kotlin.String) {
     unclassified("unclassified"),
 
     @JsonProperty(value = "unknown_default_open_api")
-    unknownDefaultOpenApi("unknown_default_open_api");
+    unknown_default_open_api("unknown_default_open_api");
 
     /**
      * Override [toString()] to avoid using the enum variable name as the value, and instead use