Skip to content

[kotlin] Fix enum defaultValue in query parameters with schema reference #22002

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

Merged
merged 1 commit into from
Sep 25, 2025
Merged

[kotlin] Fix enum defaultValue in query parameters with schema reference #22002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions ...enapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1114,6 +1114,22 @@ private static boolean isMultipartType(List<Map<String, String>> consumes) {
return false;
}

@Override
public void postProcessParameter(CodegenParameter parameter) {
super.postProcessParameter(parameter);
adjustEnumRefDefault(parameter);
}

private void adjustEnumRefDefault(CodegenParameter param) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the PR

what about adding a docstring explaining what this function does?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll do it in another pr instead.

if (StringUtils.isEmpty(param.defaultValue) || !(param.isEnum || param.isEnumRef)) {
return;
}

String type = StringUtils.defaultIfEmpty(param.datatypeWithEnum, param.dataType);
param.enumDefaultValue = toEnumVarName(param.defaultValue, type);
param.defaultValue = type + "." + param.enumDefaultValue;
}

@Override
public void postProcess() {
System.out.println("################################################################################");
Expand Down
18 changes: 18 additions & 0 deletions ...i-generator/src/test/java/org/openapitools/codegen/kotlin/KotlinClientCodegenApiTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,24 @@ public void testUseResponseAsReturnType(Object useResponseAsReturnType, String e
assertFileContainsLine(lines, "suspend fun deletePet(@Path(\"petId\") petId: kotlin.Long, @Header(\"api_key\") apiKey: kotlin.String? = null)" + expectedUnitResponse);
}

@Test
public void testEnumDefaultForReferencedSchemaParameterJvmOkhttp4() throws IOException {
OpenAPI openAPI = readOpenAPI("3_0/kotlin/enum-default-query.yaml");

KotlinClientCodegen codegen = createCodegen(ClientLibrary.JVM_OKHTTP4);
codegen.additionalProperties().put("enumPropertyNaming", "UPPERCASE");

ClientOptInput input = createClientOptInput(openAPI, codegen);

DefaultGenerator generator = new DefaultGenerator();
enableOnlyApiGeneration(generator);

List<File> files = generator.opts(input).generate();
File statusApi = files.stream().filter(file -> file.getName().equals("StatusApi.kt")).findAny().orElseThrow();

assertFileContains(statusApi.toPath(), "state: PetStatus? = PetStatus.AVAILABLE");
}

private static void assertFileContainsLine(List<String> lines, String line) {
Assert.assertListContains(lines, s -> s.equals(line), line);
}
Expand Down
26 changes: 26 additions & 0 deletions modules/openapi-generator/src/test/resources/3_0/kotlin/enum-default-query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
openapi: 3.0.1
info:
title: Enum default test
version: 1.0.0
paths:
/status:
get:
tags:
- Status
operationId: getStatus
parameters:
- name: state
in: query
schema:
$ref: '#/components/schemas/PetStatus'
responses:
'200':
description: OK
components:
schemas:
PetStatus:
type: string
enum:
- available
- pending
default: available
6 changes: 3 additions & 3 deletions samples/client/others/kotlin-jvm-okhttp-parameter-tests/docs/DefaultApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,13 @@ try {
| **pathDefault** | **kotlin.String**| path default | |
| **pathNullable** | **kotlin.String**| path_nullable | |
| **queryDefault** | **kotlin.String**| query default | [optional] [default to &quot;available&quot;] |
| **queryDefaultEnum** | **kotlin.String**| query default enum | [optional] [default to B] [enum: A, B, C] |
| **queryDefaultEnum** | **kotlin.String**| query default enum | [optional] [default to QueryDefaultEnum.B] [enum: A, B, C] |
| **queryDefaultInt** | **java.math.BigDecimal**| query default int | [optional] [default to 3] |
| **headerDefault** | **kotlin.String**| header default | [optional] [default to &quot;available&quot;] |
| **headerDefaultEnum** | **kotlin.String**| header default enum | [optional] [default to B] [enum: A, B, C] |
| **headerDefaultEnum** | **kotlin.String**| header default enum | [optional] [default to HeaderDefaultEnum.B] [enum: A, B, C] |
| **headerDefaultInt** | **java.math.BigDecimal**| header default int | [optional] [default to 3] |
| **cookieDefault** | **kotlin.String**| cookie default | [optional] [default to &quot;available&quot;] |
| **cookieDefaultEnum** | **kotlin.String**| cookie default enum | [optional] [default to B] [enum: A, B, C] |
| **cookieDefaultEnum** | **kotlin.String**| cookie default enum | [optional] [default to CookieDefaultEnum.B] [enum: A, B, C] |
| **cookieDefaultInt** | **java.math.BigDecimal**| cookie default int | [optional] [default to 3] |
| **queryNullable** | **kotlin.String**| query nullable | [optional] |
| **headerNullable** | **kotlin.String**| header nullable | [optional] |
Expand Down
18 changes: 9 additions & 9 deletions ...lin-jvm-okhttp-parameter-tests/src/main/kotlin/org/openapitools/client/apis/DefaultApi.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,13 @@ class DefaultApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory
* @param pathDefault path default
* @param pathNullable path_nullable
* @param queryDefault query default (optional, default to "available")
* @param queryDefaultEnum query default enum (optional, default to B)
* @param queryDefaultEnum query default enum (optional, default to QueryDefaultEnum.B)
* @param queryDefaultInt query default int (optional, default to 3)
* @param headerDefault header default (optional, default to "available")
* @param headerDefaultEnum header default enum (optional, default to B)
* @param headerDefaultEnum header default enum (optional, default to HeaderDefaultEnum.B)
* @param headerDefaultInt header default int (optional, default to 3)
* @param cookieDefault cookie default (optional, default to "available")
* @param cookieDefaultEnum cookie default enum (optional, default to B)
* @param cookieDefaultEnum cookie default enum (optional, default to CookieDefaultEnum.B)
* @param cookieDefaultInt cookie default int (optional, default to 3)
* @param queryNullable query nullable (optional)
* @param headerNullable header nullable (optional)
Expand Down Expand Up @@ -150,13 +150,13 @@ class DefaultApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory
* @param pathDefault path default
* @param pathNullable path_nullable
* @param queryDefault query default (optional, default to "available")
* @param queryDefaultEnum query default enum (optional, default to B)
* @param queryDefaultEnum query default enum (optional, default to QueryDefaultEnum.B)
* @param queryDefaultInt query default int (optional, default to 3)
* @param headerDefault header default (optional, default to "available")
* @param headerDefaultEnum header default enum (optional, default to B)
* @param headerDefaultEnum header default enum (optional, default to HeaderDefaultEnum.B)
* @param headerDefaultInt header default int (optional, default to 3)
* @param cookieDefault cookie default (optional, default to "available")
* @param cookieDefaultEnum cookie default enum (optional, default to B)
* @param cookieDefaultEnum cookie default enum (optional, default to CookieDefaultEnum.B)
* @param cookieDefaultInt cookie default int (optional, default to 3)
* @param queryNullable query nullable (optional)
* @param headerNullable header nullable (optional)
Expand All @@ -181,13 +181,13 @@ class DefaultApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory
* @param pathDefault path default
* @param pathNullable path_nullable
* @param queryDefault query default (optional, default to "available")
* @param queryDefaultEnum query default enum (optional, default to B)
* @param queryDefaultEnum query default enum (optional, default to QueryDefaultEnum.B)
* @param queryDefaultInt query default int (optional, default to 3)
* @param headerDefault header default (optional, default to "available")
* @param headerDefaultEnum header default enum (optional, default to B)
* @param headerDefaultEnum header default enum (optional, default to HeaderDefaultEnum.B)
* @param headerDefaultInt header default int (optional, default to 3)
* @param cookieDefault cookie default (optional, default to "available")
* @param cookieDefaultEnum cookie default enum (optional, default to B)
* @param cookieDefaultEnum cookie default enum (optional, default to CookieDefaultEnum.B)
* @param cookieDefaultInt cookie default int (optional, default to 3)
* @param queryNullable query nullable (optional)
* @param headerNullable header nullable (optional)
Expand Down
Loading