Skip to content

[kotlin-client] Support for integer enums with kotlinx with custom serializer #21746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

[kotlin-client] Support for integer enums with kotlinx with custom serializer #21746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4187dde
[kotlin-client] Add support for integer enums with custom serializer …
CHervaudBetclic Aug 14, 2025
17bf1ad
[kotlin-client] Fix @SerialName annotation being used on non-string e…
CHervaudBetclic Aug 14, 2025
caa3f2e
Format samples
CHervaudBetclic Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 42 additions & 7 deletions modules/openapi-generator/src/main/resources/kotlin-client/enum_class.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,23 @@ import kotlinx.serialization.Serializable
{{#enumUnknownDefaultCase}}
import kotlinx.serialization.KSerializer
import kotlinx.serialization.Serializer
{{^isString}}
import kotlinx.serialization.descriptors.PrimitiveKind
import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
{{/isString}}
import kotlinx.serialization.builtins.serializer
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder
{{/enumUnknownDefaultCase}}
{{^enumUnknownDefaultCase}}{{^isString}}
import kotlinx.serialization.KSerializer
import kotlinx.serialization.Serializer
import kotlinx.serialization.descriptors.PrimitiveKind
import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
import kotlinx.serialization.builtins.serializer
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder
{{/isString}}{{/enumUnknownDefaultCase}}
{{/kotlinx_serialization}}
{{/multiplatform}}
{{#multiplatform}}
Expand All @@ -33,7 +46,7 @@ import kotlinx.serialization.*
*
* Values: {{#allowableValues}}{{#enumVars}}{{&name}}{{^-last}},{{/-last}}{{/enumVars}}{{/allowableValues}}
*/
{{#multiplatform}}@Serializable{{/multiplatform}}{{#kotlinx_serialization}}@Serializable{{#enumUnknownDefaultCase}}(with = {{classname}}Serializer::class){{/enumUnknownDefaultCase}}{{/kotlinx_serialization}}
{{#multiplatform}}@Serializable{{/multiplatform}}{{#kotlinx_serialization}}@Serializable{{#enumUnknownDefaultCase}}(with = {{classname}}Serializer::class){{/enumUnknownDefaultCase}}{{^enumUnknownDefaultCase}}{{^isString}}(with = {{classname}}Serializer::class){{/isString}}{{/enumUnknownDefaultCase}}{{/kotlinx_serialization}}
{{^multiplatform}}
{{#moshi}}
@JsonClass(generateAdapter = false)
Expand All @@ -51,9 +64,9 @@ import kotlinx.serialization.*
{{#jackson}}
@JsonProperty(value = {{#lambda.doublequote}}{{{value}}}{{/lambda.doublequote}}){{#enumUnknownDefaultCase}}{{#-last}} @JsonEnumDefaultValue{{/-last}}{{/enumUnknownDefaultCase}}
{{/jackson}}
{{#kotlinx_serialization}}
{{#kotlinx_serialization}}{{#isString}}
@SerialName(value = {{#lambda.doublequote}}{{{value}}}{{/lambda.doublequote}})
{{/kotlinx_serialization}}
{{/isString}}{{/kotlinx_serialization}}
{{/multiplatform}}
{{#multiplatform}}
@SerialName(value = {{#lambda.doublequote}}{{{value}}}{{/lambda.doublequote}})
Expand Down Expand Up @@ -95,18 +108,40 @@ import kotlinx.serialization.*
}
}
}
}{{#kotlinx_serialization}}{{#enumUnknownDefaultCase}}

}
{{#kotlinx_serialization}}{{#enumUnknownDefaultCase}}
internal object {{classname}}Serializer : KSerializer<{{classname}}> {
override val descriptor = {{{dataType}}}.serializer().descriptor
override val descriptor = {{dataType}}.serializer().descriptor

override fun deserialize(decoder: Decoder): {{classname}} {
val value = decoder.decodeSerializableValue({{{dataType}}}.serializer())
return {{classname}}.values().firstOrNull { it.value == value }
{{#isString}}
?: {{classname}}.{{#allowableValues}}{{#enumVars}}{{#-last}}{{&name}}{{/-last}}{{/enumVars}}{{/allowableValues}}
{{/isString}}
{{^isString}}
?: throw IllegalArgumentException("Unknown enum value: $value")
{{/isString}}
}

override fun serialize(encoder: Encoder, value: {{classname}}) {
encoder.encodeSerializableValue({{{dataType}}}.serializer(), value.value)
}
}
{{/enumUnknownDefaultCase}}
{{^enumUnknownDefaultCase}}{{^isString}}
internal object {{classname}}Serializer : KSerializer<{{classname}}> {
override val descriptor = {{dataType}}.serializer().descriptor

override fun deserialize(decoder: Decoder): {{classname}} {
val value = decoder.decodeSerializableValue({{{dataType}}}.serializer())
return {{classname}}.values().firstOrNull { it.value == value }
?: throw IllegalArgumentException("Unknown enum value: $value")
}

override fun serialize(encoder: Encoder, value: {{classname}}) {
encoder.encodeSerializableValue({{{dataType}}}.serializer(), value.value)
}
}{{/enumUnknownDefaultCase}}{{/kotlinx_serialization}}
}
{{/isString}}{{/enumUnknownDefaultCase}}
{{/kotlinx_serialization}}
3 changes: 3 additions & 0 deletions ..._api/kotlin-jvm-okhttp/src/main/kotlin/org/openapitools/client/models/ApiStringEnumRef.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,15 @@ import com.squareup.moshi.JsonClass
enum class ApiStringEnumRef(val value: kotlin.String) {

@Json(name = "success")

success("success"),

@Json(name = "failure")

failure("failure"),

@Json(name = "unclassified")

unclassified("unclassified");

/**
Expand Down
4 changes: 4 additions & 0 deletions ...n-jvm-spring-3-restclient/src/main/kotlin/org/openapitools/client/models/StringEnumRef.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,19 @@ import com.fasterxml.jackson.annotation.JsonProperty
enum class StringEnumRef(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

unknown_default_open_api("unknown_default_open_api");

/**
Expand Down
4 changes: 4 additions & 0 deletions ...in-jvm-spring-3-webclient/src/main/kotlin/org/openapitools/client/models/StringEnumRef.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,19 @@ import com.fasterxml.jackson.annotation.JsonProperty
enum class StringEnumRef(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

unknown_default_open_api("unknown_default_open_api");

/**
Expand Down
3 changes: 3 additions & 0 deletions ...l-prefix-type-mappings/src/main/kotlin/org/openapitools/client/models/ApiStringEnumRef.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,15 @@ import com.google.gson.annotations.SerializedName
enum class ApiStringEnumRef(val value: kotlin.String) {

@SerializedName(value = "success")

SUCCESS("success"),

@SerializedName(value = "failure")

FAILURE("failure"),

@SerializedName(value = "unclassified")

UNCLASSIFIED("unclassified");

/**
Expand Down
8 changes: 8 additions & 0 deletions .../petstore/kotlin-uppercase-enum/src/main/kotlin/org/openapitools/client/models/PetEnum.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import kotlinx.serialization.builtins.serializer
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder


/**
* An enum with complex-ish naming
*
Expand All @@ -32,13 +33,19 @@ import kotlinx.serialization.encoding.Encoder
@Serializable(with = PetEnumSerializer::class)
enum class PetEnum(val value: kotlin.String) {


@SerialName(value = "myFirstValue")

MY_FIRST_VALUE("myFirstValue"),


@SerialName(value = "MY_SECOND_VALUE")

MY_SECOND_VALUE("MY_SECOND_VALUE"),


@SerialName(value = "unknown_default_open_api")

UNKNOWN_DEFAULT_OPEN_API("unknown_default_open_api");

/**
Expand Down Expand Up @@ -82,3 +89,4 @@ internal object PetEnumSerializer : KSerializer<PetEnum> {
}
}


Loading