[swift6] Emit enum description for query parameters (#24639)

x-sheep · web-flow · commit 41917fb4ed7a · 2026-08-07T17:49:32.000+01:00
diff --git a/modules/openapi-generator/src/main/resources/swift6/api.mustache b/modules/openapi-generator/src/main/resources/swift6/api.mustache
@@ -34,6 +34,9 @@ extension {{projectName}}API {
         {{^enumUnknownDefaultCase}}
         {{#allowableValues}}
         {{#enumVars}}
+        {{#enumDescription}}
+        /** {{.}} */
+        {{/enumDescription}}
         case {{name}} = {{{value}}}
         {{/enumVars}}
         {{/allowableValues}}
diff --git a/modules/openapi-generator/src/main/resources/swift6/modelEnum.mustache b/modules/openapi-generator/src/main/resources/swift6/modelEnum.mustache
@@ -3,7 +3,7 @@
 {{#allowableValues}}
 {{#enumVars}}
     {{#enumDescription}}
-    /// {{enumDescription}}
+    /** {{.}} */
     {{/enumDescription}}
     case {{{name}}} = {{{value}}}
 {{/enumVars}}
diff --git a/modules/openapi-generator/src/main/resources/swift6/modelInlineEnumDeclaration.mustache b/modules/openapi-generator/src/main/resources/swift6/modelInlineEnumDeclaration.mustache
@@ -2,7 +2,7 @@
         {{#allowableValues}}
         {{#enumVars}}
         {{#enumDescription}}
-        /// {{enumDescription}}
+        /** {{.}} */
         {{/enumDescription}}
         case {{{name}}} = {{{value}}}
         {{/enumVars}}
diff --git a/modules/openapi-generator/src/test/resources/2_0/swift/petstore-with-fake-endpoints-models-for-testing.yaml b/modules/openapi-generator/src/test/resources/2_0/swift/petstore-with-fake-endpoints-models-for-testing.yaml
@@ -98,6 +98,10 @@ paths:
               - available
               - pending
               - sold
+            x-enum-descriptions:
+              - Label for available status
+              - Other label for pending status
+              - Another label for sold status
             default: available
           collectionFormat: csv
       responses:
diff --git a/samples/client/petstore/swift6/alamofireLibrary/Sources/PetstoreClient/APIs/PetAPI.swift b/samples/client/petstore/swift6/alamofireLibrary/Sources/PetstoreClient/APIs/PetAPI.swift
@@ -115,8 +115,11 @@ open class PetAPI {
      * enum for parameter status
      */
     public enum Status_findPetsByStatus: String, Sendable, CaseIterable {
+        /** Label for available status */
         case available = "available"
+        /** Other label for pending status */
         case pending = "pending"
+        /** Another label for sold status */
         case sold = "sold"
     }
 
diff --git a/samples/client/petstore/swift6/alamofireLibrary/Sources/PetstoreClient/Models/EnumTest.swift b/samples/client/petstore/swift6/alamofireLibrary/Sources/PetstoreClient/Models/EnumTest.swift
@@ -24,9 +24,9 @@ public struct EnumTest: Sendable, Codable, Hashable {
         case number1 = -1
     }
     public enum EnumNumber: Double, Sendable, Codable, CaseIterable {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
     }
     public var enumString: EnumString?
diff --git a/samples/client/petstore/swift6/alamofireLibrary/Sources/PetstoreClient/Models/OuterEnum.swift b/samples/client/petstore/swift6/alamofireLibrary/Sources/PetstoreClient/Models/OuterEnum.swift
@@ -8,10 +8,10 @@
 import Foundation
 
 public enum OuterEnum: String, Sendable, Codable, CaseIterable {
-    /// Description for placed
+    /** Description for placed */
     case placed = "placed"
-    /// Description for approved
+    /** Description for approved */
     case approved = "approved"
-    /// Description for delivered
+    /** Description for delivered */
     case delivered = "delivered"
 }
diff --git a/samples/client/petstore/swift6/apiNonStaticMethod/Sources/PetstoreClient/APIs/PetAPI.swift b/samples/client/petstore/swift6/apiNonStaticMethod/Sources/PetstoreClient/APIs/PetAPI.swift
@@ -323,8 +323,11 @@ open class PetAPI {
      * enum for parameter status
      */
     public enum Status_findPetsByStatus: String, Sendable, CaseIterable {
+        /** Label for available status */
         case available = "available"
+        /** Other label for pending status */
         case pending = "pending"
+        /** Another label for sold status */
         case sold = "sold"
     }
 
diff --git a/samples/client/petstore/swift6/apiNonStaticMethod/Sources/PetstoreClient/Models/EnumTest.swift b/samples/client/petstore/swift6/apiNonStaticMethod/Sources/PetstoreClient/Models/EnumTest.swift
@@ -24,9 +24,9 @@ public struct EnumTest: Sendable, Codable, Hashable {
         case number1 = -1
     }
     public enum EnumNumber: Double, Sendable, Codable, CaseIterable {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
     }
     public var enumString: EnumString?
diff --git a/samples/client/petstore/swift6/apiNonStaticMethod/Sources/PetstoreClient/Models/OuterEnum.swift b/samples/client/petstore/swift6/apiNonStaticMethod/Sources/PetstoreClient/Models/OuterEnum.swift
@@ -8,10 +8,10 @@
 import Foundation
 
 public enum OuterEnum: String, Sendable, Codable, CaseIterable {
-    /// Description for placed
+    /** Description for placed */
     case placed = "placed"
-    /// Description for approved
+    /** Description for approved */
     case approved = "approved"
-    /// Description for delivered
+    /** Description for delivered */
     case delivered = "delivered"
 }
diff --git a/samples/client/petstore/swift6/asyncAwaitLibrary/Sources/PetstoreClient/APIs/PetAPI.swift b/samples/client/petstore/swift6/asyncAwaitLibrary/Sources/PetstoreClient/APIs/PetAPI.swift
@@ -99,8 +99,11 @@ open class PetAPI {
      * enum for parameter status
      */
     public enum Status_findPetsByStatus: String, Sendable, CaseIterable {
+        /** Label for available status */
         case available = "available"
+        /** Other label for pending status */
         case pending = "pending"
+        /** Another label for sold status */
         case sold = "sold"
     }
 
diff --git a/samples/client/petstore/swift6/asyncAwaitLibrary/Sources/PetstoreClient/Models/EnumTest.swift b/samples/client/petstore/swift6/asyncAwaitLibrary/Sources/PetstoreClient/Models/EnumTest.swift
@@ -24,9 +24,9 @@ public struct EnumTest: Sendable, Codable, Hashable {
         case number1 = -1
     }
     public enum EnumNumber: Double, Sendable, Codable, CaseIterable {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
     }
     public var enumString: EnumString?
diff --git a/samples/client/petstore/swift6/asyncAwaitLibrary/Sources/PetstoreClient/Models/OuterEnum.swift b/samples/client/petstore/swift6/asyncAwaitLibrary/Sources/PetstoreClient/Models/OuterEnum.swift
@@ -8,10 +8,10 @@
 import Foundation
 
 public enum OuterEnum: String, Sendable, Codable, CaseIterable {
-    /// Description for placed
+    /** Description for placed */
     case placed = "placed"
-    /// Description for approved
+    /** Description for approved */
     case approved = "approved"
-    /// Description for delivered
+    /** Description for delivered */
     case delivered = "delivered"
 }
diff --git a/samples/client/petstore/swift6/combineDeferredLibrary/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift b/samples/client/petstore/swift6/combineDeferredLibrary/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift
@@ -136,8 +136,11 @@ open class PetAPI {
      * enum for parameter status
      */
     public enum Status_findPetsByStatus: String, Sendable, CaseIterable {
+        /** Label for available status */
         case available = "available"
+        /** Other label for pending status */
         case pending = "pending"
+        /** Another label for sold status */
         case sold = "sold"
     }
 
diff --git a/samples/client/petstore/swift6/combineDeferredLibrary/PetstoreClient/Classes/OpenAPIs/Models/EnumTest.swift b/samples/client/petstore/swift6/combineDeferredLibrary/PetstoreClient/Classes/OpenAPIs/Models/EnumTest.swift
@@ -24,9 +24,9 @@ public struct EnumTest: Sendable, Codable, Hashable {
         case number1 = -1
     }
     public enum EnumNumber: Double, Sendable, Codable, CaseIterable {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
     }
     public var enumString: EnumString?
diff --git a/samples/client/petstore/swift6/combineDeferredLibrary/PetstoreClient/Classes/OpenAPIs/Models/OuterEnum.swift b/samples/client/petstore/swift6/combineDeferredLibrary/PetstoreClient/Classes/OpenAPIs/Models/OuterEnum.swift
@@ -8,10 +8,10 @@
 import Foundation
 
 public enum OuterEnum: String, Sendable, Codable, CaseIterable {
-    /// Description for placed
+    /** Description for placed */
     case placed = "placed"
-    /// Description for approved
+    /** Description for approved */
     case approved = "approved"
-    /// Description for delivered
+    /** Description for delivered */
     case delivered = "delivered"
 }
diff --git a/samples/client/petstore/swift6/combineLibrary/Sources/CombineLibrary/APIs/PetAPI.swift b/samples/client/petstore/swift6/combineLibrary/Sources/CombineLibrary/APIs/PetAPI.swift
@@ -132,8 +132,11 @@ open class PetAPI {
      * enum for parameter status
      */
     public enum Status_findPetsByStatus: String, Sendable, CaseIterable {
+        /** Label for available status */
         case available = "available"
+        /** Other label for pending status */
         case pending = "pending"
+        /** Another label for sold status */
         case sold = "sold"
     }
 
diff --git a/samples/client/petstore/swift6/combineLibrary/Sources/CombineLibrary/Models/EnumTest.swift b/samples/client/petstore/swift6/combineLibrary/Sources/CombineLibrary/Models/EnumTest.swift
@@ -24,9 +24,9 @@ public struct EnumTest: Sendable, Codable, Hashable {
         case number1 = -1
     }
     public enum EnumNumber: Double, Sendable, Codable, CaseIterable {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
     }
     public var enumString: EnumString?
diff --git a/samples/client/petstore/swift6/combineLibrary/Sources/CombineLibrary/Models/OuterEnum.swift b/samples/client/petstore/swift6/combineLibrary/Sources/CombineLibrary/Models/OuterEnum.swift
@@ -8,10 +8,10 @@
 import Foundation
 
 public enum OuterEnum: String, Sendable, Codable, CaseIterable {
-    /// Description for placed
+    /** Description for placed */
     case placed = "placed"
-    /// Description for approved
+    /** Description for approved */
     case approved = "approved"
-    /// Description for delivered
+    /** Description for delivered */
     case delivered = "delivered"
 }
diff --git a/samples/client/petstore/swift6/objcCompatible/Sources/PetstoreClient/APIs/PetAPI.swift b/samples/client/petstore/swift6/objcCompatible/Sources/PetstoreClient/APIs/PetAPI.swift
@@ -115,8 +115,11 @@ import Foundation
      * enum for parameter status
      */
     public enum Status_findPetsByStatus: String, Sendable, CaseIterable {
+        /** Label for available status */
         case available = "available"
+        /** Other label for pending status */
         case pending = "pending"
+        /** Another label for sold status */
         case sold = "sold"
     }
 
diff --git a/samples/client/petstore/swift6/objcCompatible/Sources/PetstoreClient/Models/EnumTest.swift b/samples/client/petstore/swift6/objcCompatible/Sources/PetstoreClient/Models/EnumTest.swift
@@ -24,9 +24,9 @@ import Foundation
         case number1 = -1
     }
     public enum EnumNumber: Double, Sendable, Codable, CaseIterable {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
     }
     public var enumString: EnumString?
diff --git a/samples/client/petstore/swift6/objcCompatible/Sources/PetstoreClient/Models/OuterEnum.swift b/samples/client/petstore/swift6/objcCompatible/Sources/PetstoreClient/Models/OuterEnum.swift
@@ -8,10 +8,10 @@
 import Foundation
 
 public enum OuterEnum: String, Sendable, Codable, CaseIterable {
-    /// Description for placed
+    /** Description for placed */
     case placed = "placed"
-    /// Description for approved
+    /** Description for approved */
     case approved = "approved"
-    /// Description for delivered
+    /** Description for delivered */
     case delivered = "delivered"
 }
diff --git a/samples/client/petstore/swift6/promisekitLibrary/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift b/samples/client/petstore/swift6/promisekitLibrary/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift
@@ -120,8 +120,11 @@ open class PetAPI {
      * enum for parameter status
      */
     public enum Status_findPetsByStatus: String, Sendable, CaseIterable {
+        /** Label for available status */
         case available = "available"
+        /** Other label for pending status */
         case pending = "pending"
+        /** Another label for sold status */
         case sold = "sold"
     }
 
diff --git a/samples/client/petstore/swift6/promisekitLibrary/PetstoreClient/Classes/OpenAPIs/Models/EnumTest.swift b/samples/client/petstore/swift6/promisekitLibrary/PetstoreClient/Classes/OpenAPIs/Models/EnumTest.swift
@@ -24,9 +24,9 @@ public struct EnumTest: Sendable, Codable, Hashable {
         case number1 = -1
     }
     public enum EnumNumber: Double, Sendable, Codable, CaseIterable {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
     }
     public var enumString: EnumString?
diff --git a/samples/client/petstore/swift6/promisekitLibrary/PetstoreClient/Classes/OpenAPIs/Models/OuterEnum.swift b/samples/client/petstore/swift6/promisekitLibrary/PetstoreClient/Classes/OpenAPIs/Models/OuterEnum.swift
@@ -8,10 +8,10 @@
 import Foundation
 
 public enum OuterEnum: String, Sendable, Codable, CaseIterable {
-    /// Description for placed
+    /** Description for placed */
     case placed = "placed"
-    /// Description for approved
+    /** Description for approved */
     case approved = "approved"
-    /// Description for delivered
+    /** Description for delivered */
     case delivered = "delivered"
 }
diff --git a/samples/client/petstore/swift6/resultLibrary/PetstoreClient/Classes/OpenAPIs/Models/EnumTest.swift b/samples/client/petstore/swift6/resultLibrary/PetstoreClient/Classes/OpenAPIs/Models/EnumTest.swift
@@ -27,9 +27,9 @@ internal struct EnumTest: Sendable, Codable {
         case unknownDefaultOpenApi = 11184809
     }
     internal enum EnumNumber: Double, Sendable, Codable, CaseIterable, CaseIterableDefaultsLast {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
         case unknownDefaultOpenApi = 11184809
     }
diff --git a/samples/client/petstore/swift6/resultLibrary/PetstoreClient/Classes/OpenAPIs/Models/OuterEnum.swift b/samples/client/petstore/swift6/resultLibrary/PetstoreClient/Classes/OpenAPIs/Models/OuterEnum.swift
@@ -8,11 +8,11 @@
 import Foundation
 
 internal enum OuterEnum: String, Sendable, Codable, CaseIterable, CaseIterableDefaultsLast {
-    /// Description for placed
+    /** Description for placed */
     case placed = "placed"
-    /// Description for approved
+    /** Description for approved */
     case approved = "approved"
-    /// Description for delivered
+    /** Description for delivered */
     case delivered = "delivered"
     case unknownDefaultOpenApi = "unknown_default_open_api"
 }
diff --git a/samples/client/petstore/swift6/rxswiftLibrary/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift b/samples/client/petstore/swift6/rxswiftLibrary/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift
@@ -128,8 +128,11 @@ open class PetAPI {
      * enum for parameter status
      */
     public enum Status_findPetsByStatus: String, Sendable, CaseIterable {
+        /** Label for available status */
         case available = "available"
+        /** Other label for pending status */
         case pending = "pending"
+        /** Another label for sold status */
         case sold = "sold"
     }
 
diff --git a/samples/client/petstore/swift6/rxswiftLibrary/PetstoreClient/Classes/OpenAPIs/Models/EnumTest.swift b/samples/client/petstore/swift6/rxswiftLibrary/PetstoreClient/Classes/OpenAPIs/Models/EnumTest.swift
@@ -24,9 +24,9 @@ public struct EnumTest: Sendable, Codable, Hashable {
         case number1 = -1
     }
     public enum EnumNumber: Double, Sendable, Codable, CaseIterable {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
     }
     public var enumString: EnumString?
diff --git a/samples/client/petstore/swift6/rxswiftLibrary/PetstoreClient/Classes/OpenAPIs/Models/OuterEnum.swift b/samples/client/petstore/swift6/rxswiftLibrary/PetstoreClient/Classes/OpenAPIs/Models/OuterEnum.swift
@@ -8,10 +8,10 @@
 import Foundation
 
 public enum OuterEnum: String, Sendable, Codable, CaseIterable {
-    /// Description for placed
+    /** Description for placed */
     case placed = "placed"
-    /// Description for approved
+    /** Description for approved */
     case approved = "approved"
-    /// Description for delivered
+    /** Description for delivered */
     case delivered = "delivered"
 }
diff --git a/samples/client/petstore/swift6/urlsessionLibrary/Sources/PetstoreClient/APIs/PetAPI.swift b/samples/client/petstore/swift6/urlsessionLibrary/Sources/PetstoreClient/APIs/PetAPI.swift
@@ -118,8 +118,11 @@ open class PetAPI {
      * enum for parameter status
      */
     public enum Status_findPetsByStatus: String, Sendable, CaseIterable {
+        /** Label for available status */
         case available = "available"
+        /** Other label for pending status */
         case pending = "pending"
+        /** Another label for sold status */
         case sold = "sold"
     }
 
diff --git a/samples/client/petstore/swift6/urlsessionLibrary/Sources/PetstoreClient/Models/EnumTest.swift b/samples/client/petstore/swift6/urlsessionLibrary/Sources/PetstoreClient/Models/EnumTest.swift
@@ -29,9 +29,9 @@ public final class EnumTest: @unchecked Sendable, Codable, Hashable {
         case number1 = -1
     }
     public enum EnumNumber: Double, Sendable, Codable, CaseIterable {
-        /// Description for 1.1
+        /** Description for 1.1 */
         case _11 = 1.1
-        /// Description for -1.2
+        /** Description for -1.2 */
         case number12 = -1.2
     }
     public private(set) var enumString: EnumString?
diff --git a/samples/client/petstore/swift6/urlsessionLibrary/Sources/PetstoreClient/Models/OuterEnum.swift b/samples/client/petstore/swift6/urlsessionLibrary/Sources/PetstoreClient/Models/OuterEnum.swift

Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,9 @@ public struct EnumTest: Sendable, Codable, Hashable {`
`24`	`24`	`case number1 = -1`
`25`	`25`	`}`
`26`	`26`	`public enum EnumNumber: Double, Sendable, Codable, CaseIterable {`
`27`		`- /// Description for 1.1`
	`27`	`+ /** Description for 1.1 */`
`28`	`28`	`case _11 = 1.1`
`29`		`- /// Description for -1.2`
	`29`	`+ /** Description for -1.2 */`
`30`	`30`	`case number12 = -1.2`
`31`	`31`	`}`
`32`	`32`	`public var enumString: EnumString?`