Skip to content

[bug][kotlin-spring] fix allowableValues quotes in documentation annnotations #21700

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
wing328 merged 5 commits into from
Aug 6, 2025
Merged

[bug][kotlin-spring] fix allowableValues quotes in documentation annnotations #21700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
adbbe4e
[bug][kotlin-spring] fix allowableValues quotes in documentation anno…
cgual-omnidian Aug 5, 2025
3fa6fe7
Remove unused imports in KotlinSpringServerCodegenTest
cgual-omnidian Aug 5, 2025
6041fb3
Fix Swagger1 annotation
cgual-omnidian Aug 5, 2025
952bae0
Streamline Swagger1 annotation
cgual-omnidian Aug 5, 2025
7e8176b
Remove extra line break
cgual-omnidian Aug 5, 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
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/kotlin-spring/pathParams.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{{#isPathParam}}{{#useBeanValidation}}{{>beanValidationPathParams}}{{/useBeanValidation}}{{#swagger2AnnotationLibrary}}@Parameter(description = "{{{description}}}"{{#required}}, required = true{{/required}}{{#allowableValues}}{{#defaultValue}}, schema = Schema(allowableValues = [{{#enumVars}}"{{#lambdaEscapeInNormalString}}{{{value}}}{{/lambdaEscapeInNormalString}}"{{^-last}}, {{/-last}}{{/enumVars}}]{{^isContainer}}, defaultValue = {{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/isContainer}}){{/defaultValue}}{{/allowableValues}}{{#allowableValues}}{{^defaultValue}}, schema = Schema(allowableValues = [{{#enumVars}}"{{#lambdaEscapeInNormalString}}{{{value}}}{{/lambdaEscapeInNormalString}}"{{^-last}}, {{/-last}}{{/enumVars}}]){{/defaultValue}}{{/allowableValues}}{{^allowableValues}}{{#defaultValue}}{{^isContainer}}, schema = Schema(defaultValue = {{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}){{/isContainer}}{{/defaultValue}}{{/allowableValues}}){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}@ApiParam(value = "{{{description}}}"{{#required}}, required = true{{/required}}{{#allowableValues}}, allowableValues = "{{#enumVars}}{{#lambda.escapeDoubleQuote}}{{{value}}}{{/lambda.escapeDoubleQuote}}{{^-last}}, {{/-last}}{{/enumVars}}"{{/allowableValues}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/swagger1AnnotationLibrary}} @PathVariable("{{baseName}}") {{{paramName}}}: {{>optionalDataType}}{{/isPathParam}}
{{#isPathParam}}{{#useBeanValidation}}{{>beanValidationPathParams}}{{/useBeanValidation}}{{#swagger2AnnotationLibrary}}@Parameter(description = "{{{description}}}"{{#required}}, required = true{{/required}}{{#allowableValues}}{{#defaultValue}}, schema = Schema(allowableValues = [{{#values}}"{{{.}}}"{{^-last}}, {{/-last}}{{/values}}]{{^isContainer}}, defaultValue = {{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/isContainer}}){{/defaultValue}}{{/allowableValues}}{{#allowableValues}}{{^defaultValue}}, schema = Schema(allowableValues = [{{#values}}"{{{.}}}"{{^-last}}, {{/-last}}{{/values}}]){{/defaultValue}}{{/allowableValues}}{{^allowableValues}}{{#defaultValue}}{{^isContainer}}, schema = Schema(defaultValue = {{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}){{/isContainer}}{{/defaultValue}}{{/allowableValues}}){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}@ApiParam(value = "{{{description}}}"{{#required}}, required = true{{/required}}{{#allowableValues}}, allowableValues = "{{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}"{{/allowableValues}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/swagger1AnnotationLibrary}} @PathVariable("{{baseName}}") {{{paramName}}}: {{>optionalDataType}}{{/isPathParam}}
77 changes: 76 additions & 1 deletion ...r/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import io.swagger.v3.parser.core.models.ParseOptions;
import java.util.HashMap;
import java.util.function.Consumer;
import java.util.stream.Stream;
import org.apache.commons.io.FileUtils;
import org.assertj.core.api.Assertions;
import org.jetbrains.annotations.NotNull;
Expand All @@ -15,13 +16,14 @@
import org.openapitools.codegen.DefaultGenerator;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.config.CodegenConfigurator;
import org.openapitools.codegen.java.assertions.JavaFileAssert;
import org.openapitools.codegen.kotlin.KotlinTestUtils;
import org.openapitools.codegen.languages.KotlinSpringServerCodegen;
import org.openapitools.codegen.languages.features.CXFServerFeatures;
import org.openapitools.codegen.languages.features.DocumentationProviderFeatures;
import org.openapitools.codegen.languages.features.DocumentationProviderFeatures.AnnotationLibrary;
import org.openapitools.codegen.languages.features.DocumentationProviderFeatures.DocumentationProvider;
import org.testng.Assert;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;

import java.io.File;
Expand Down Expand Up @@ -1232,6 +1234,79 @@ public void testValidationsInQueryParams_issue21238_Api_Delegate() throws IOExce
"@NotNull", "@Valid", "@Pattern(regexp=\"^[a-zA-Z0-9]+[a-zA-Z0-9\\\\.\\\\-_]*[a-zA-Z0-9]+$\")");
}

@DataProvider
public Object[][] issue17997DocumentationProviders() {
return new Object[][]{
{DocumentationProviderFeatures.DocumentationProvider.SPRINGDOC.name(),
(Consumer<Path>) outputPath ->
assertFileContains(
outputPath,
"allowableValues = [\"0\", \"1\"], defaultValue = \"0\"",
"@PathVariable"
),
(Consumer<Path>) outputPath ->
assertFileContains(
outputPath,
"allowableValues = [\"sleeping\", \"awake\"]", "@PathVariable",
"@PathVariable"
)
},
{DocumentationProviderFeatures.DocumentationProvider.SPRINGFOX.name(),
(Consumer<Path>) outputPath ->
assertFileContains(
outputPath,
"allowableValues = \"0, 1\", defaultValue = \"0\"",
"@PathVariable"
),
(Consumer<Path>) outputPath ->
assertFileContains(
outputPath,
"allowableValues = \"sleeping, awake\"", "@PathVariable",
"@PathVariable"
)
}
};
}

@Test(dataProvider = "issue17997DocumentationProviders")
public void testDocumentationAnnotationInPathParams_Issue17997(
String documentProvider,
Consumer<Path> intEnumAssertFunction,
Consumer<Path> stringEnumAssertFunction
) throws IOException {
Map<String, Object> additionalProperties = new HashMap<>();
additionalProperties.put(DOCUMENTATION_PROVIDER, documentProvider);

Map<String, String> generatorPropertyDefaults = new HashMap<>();
generatorPropertyDefaults.put(CodegenConstants.MODEL_TESTS, "false");
generatorPropertyDefaults.put(CodegenConstants.MODEL_DOCS, "false");
generatorPropertyDefaults.put(CodegenConstants.APIS, "true");

Map<String, File> files = generateFromContract(
"src/test/resources/3_0/issue_6762.yaml",
additionalProperties,
generatorPropertyDefaults
);

Stream.of(
"ZebrasApiController.kt",
"GiraffesApiController.kt"
).forEach(filename -> {
File file = files.get(filename);
assertThat(file).isNotNull();
intEnumAssertFunction.accept(file.toPath());
});

Stream.of(
"BearsApiController.kt",
"CamelsApiController.kt"
).forEach(filename -> {
File file = files.get(filename);
assertThat(file).isNotNull();
stringEnumAssertFunction.accept(file.toPath());
});
}

private Map<String, File> generateFromContract(String url) throws IOException {
return generateFromContract(url, new HashMap<>(), new HashMap<>());
}
Expand Down
14 changes: 13 additions & 1 deletion modules/openapi-generator/src/test/resources/3_0/issue_6762.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ paths:
operationId: getGiraffes
parameters:
- $ref: '#/components/parameters/refStatus'
responses:
"204":
description: Successful response
/zebras/{status}:
get:
operationId: getZebras
Expand All @@ -24,11 +27,17 @@ paths:
type: integer
enum: [0,1]
default: 0
responses:
"204":
description: Successful response
/bears/{refCondition}:
get:
operationId: getBears
parameters:
- $ref: '#/components/parameters/refCondition'
responses:
"204":
description: Successful response
/camels/{condition}:
get:
operationId: getCamels
Expand All @@ -41,6 +50,9 @@ paths:
enum:
- sleeping
- awake
responses:
"204":
description: Successful response
components:
parameters:
refStatus:
Expand All @@ -58,4 +70,4 @@ components:
type: string
enum:
- sleeping
- awake
- awake
Loading