diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java index 8d9283033f85..8105ce3ff44d 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java @@ -1513,6 +1513,14 @@ protected String getExtraListAnnotation(Schema items) { return String.join(" ", annotations); } + @Override + protected void updateParameterForString(CodegenParameter codegenParameter, Schema parameterSchema) { + super.updateParameterForString(codegenParameter, parameterSchema); + if (ModelUtils.isURISchema(parameterSchema)) { + codegenParameter.isUri = true; + } + } + /** * Bean validation for the element type of a list/set, following the rules of * {@code AbstractJavaCodegen#getBeanValidation} and rendered in the format of {@code beanValidationCore.mustache}. diff --git a/modules/openapi-generator/src/main/resources/kotlin-spring/beanValidationCore.mustache b/modules/openapi-generator/src/main/resources/kotlin-spring/beanValidationCore.mustache index b14fb649c69a..0a1a3515284f 100644 --- a/modules/openapi-generator/src/main/resources/kotlin-spring/beanValidationCore.mustache +++ b/modules/openapi-generator/src/main/resources/kotlin-spring/beanValidationCore.mustache @@ -1,12 +1,12 @@ {{#isEmail}}@Email {{/isEmail}}{{! -pattern set -}}{{#pattern}}@Pattern(regexp="{{{.}}}"{{#vendorExtensions.x-pattern-message}}, message="{{vendorExtensions.x-pattern-message}}"{{/vendorExtensions.x-pattern-message}}) {{/pattern}}{{! -minLength && maxLength set -}}{{#minLength}}{{#maxLength}}@Size(min={{minLength}},max={{maxLength}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}) {{/maxLength}}{{/minLength}}{{! +pattern set; URI is not supported by Bean Validation @Pattern +}}{{#pattern}}{{^isUri}}@Pattern(regexp="{{{.}}}"{{#vendorExtensions.x-pattern-message}}, message="{{vendorExtensions.x-pattern-message}}"{{/vendorExtensions.x-pattern-message}}) {{/isUri}}{{/pattern}}{{! +minLength && maxLength set; URI is not supported by Bean Validation @Size +}}{{#minLength}}{{#maxLength}}{{^isUri}}@Size(min={{minLength}},max={{maxLength}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}) {{/isUri}}{{/maxLength}}{{/minLength}}{{! minLength set, maxLength not -}}{{#minLength}}{{^maxLength}}@Size(min={{minLength}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}) {{/maxLength}}{{/minLength}}{{! +}}{{#minLength}}{{^maxLength}}{{^isUri}}@Size(min={{minLength}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}) {{/isUri}}{{/maxLength}}{{/minLength}}{{! minLength not set, maxLength set -}}{{^minLength}}{{#maxLength}}@Size(max={{.}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}) {{/maxLength}}{{/minLength}}{{! +}}{{^minLength}}{{#maxLength}}{{^isUri}}@Size(max={{.}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}) {{/isUri}}{{/maxLength}}{{/minLength}}{{! @Size: minItems && maxItems set }}{{#minItems}}{{#maxItems}}@Size(min={{minItems}},max={{maxItems}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}) {{/maxItems}}{{/minItems}}{{! @Size: minItems set, maxItems not diff --git a/modules/openapi-generator/src/main/resources/kotlin-spring/beanValidationModel.mustache b/modules/openapi-generator/src/main/resources/kotlin-spring/beanValidationModel.mustache index 1522232e2f9e..ff31aa5fb061 100644 --- a/modules/openapi-generator/src/main/resources/kotlin-spring/beanValidationModel.mustache +++ b/modules/openapi-generator/src/main/resources/kotlin-spring/beanValidationModel.mustache @@ -2,18 +2,18 @@ format: email }}{{#isEmail}} @get:Email{{/isEmail}}{{! -pattern set -}}{{#pattern}} - @get:Pattern(regexp="{{{pattern}}}"{{#vendorExtensions.x-pattern-message}}, message="{{vendorExtensions.x-pattern-message}}"{{/vendorExtensions.x-pattern-message}}){{/pattern}}{{! -minLength && maxLength set -}}{{#minLength}}{{#maxLength}} - @get:Size(min={{minLength}},max={{maxLength}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}){{/maxLength}}{{/minLength}}{{! +pattern set; URI is not supported by Bean Validation @Pattern +}}{{#pattern}}{{^isUri}} + @get:Pattern(regexp="{{{pattern}}}"{{#vendorExtensions.x-pattern-message}}, message="{{vendorExtensions.x-pattern-message}}"{{/vendorExtensions.x-pattern-message}}){{/isUri}}{{/pattern}}{{! +minLength && maxLength set; URI is not supported by Bean Validation @Size +}}{{#minLength}}{{#maxLength}}{{^isUri}} + @get:Size(min={{minLength}},max={{maxLength}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}){{/isUri}}{{/maxLength}}{{/minLength}}{{! minLength set, maxLength not -}}{{#minLength}}{{^maxLength}} - @get:Size(min={{minLength}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}){{/maxLength}}{{/minLength}}{{! +}}{{#minLength}}{{^maxLength}}{{^isUri}} + @get:Size(min={{minLength}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}){{/isUri}}{{/maxLength}}{{/minLength}}{{! minLength not set, maxLength set -}}{{^minLength}}{{#maxLength}} - @get:Size(max={{.}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}){{/maxLength}}{{/minLength}}{{! +}}{{^minLength}}{{#maxLength}}{{^isUri}} + @get:Size(max={{.}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}){{/isUri}}{{/maxLength}}{{/minLength}}{{! @Size: minItems && maxItems set }}{{#minItems}}{{#maxItems}} @get:Size(min={{minItems}},max={{maxItems}}{{#vendorExtensions.x-size-message}}, message="{{vendorExtensions.x-size-message}}"{{/vendorExtensions.x-size-message}}) {{/maxItems}}{{/minItems}}{{! diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java index 720075e4cc2a..a699c5878736 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java @@ -8032,6 +8032,72 @@ public void kdocParamNameIsNotHtmlEscaped() throws IOException { assertFileContains(itemFile.toPath(), "@param `2ndField` "); } + @Test(description = "URI properties and parameters do not get unsupported Bean Validation annotations") + public void uriPropertiesAndParametersDoNotGetPatternOrSizeConstraints() throws IOException { + Map files = generateFromContract( + "src/test/resources/3_0/kotlin/uri-validation-pattern.yaml", + new HashMap<>(Map.of(USE_BEANVALIDATION, true)) + ); + + File modelFile = files.get("UriPayload.kt"); + assertThat(modelFile).isNotNull(); + String model = Files.readString(modelFile.toPath()); + + assertThat(model).contains("uri: java.net.URI?"); + assertThat(getKotlinPropertyAnnotations(model, "uri")) + .doesNotContain("@get:Pattern(regexp=\"^https?://\")") + .doesNotContain("@get:Size"); + assertThat(getKotlinPropertyAnnotations(model, "uriMaxLength")).doesNotContain("@get:Size"); + assertThat(getKotlinPropertyAnnotations(model, "uriMinMaxLength")).doesNotContain("@get:Size"); + assertThat(getKotlinPropertyAnnotations(model, "plainString")) + .contains("@get:Pattern(regexp=\"^[a-z]+$\")") + .contains("@get:Size(min=1)"); + assertThat(getKotlinPropertyAnnotations(model, "plainStringMaxLength")).contains("@get:Size(max=10)"); + assertThat(getKotlinPropertyAnnotations(model, "plainStringMinMaxLength")) + .contains("@get:Size(min=2,max=12)"); + + File apiFile = files.get("UriPayloadApiController.kt"); + assertThat(apiFile).isNotNull(); + String api = Files.readString(apiFile.toPath()); + assertThat(api).contains("uriParam: java.net.URI?"); + assertThat(getKotlinParameterAnnotations(api, "uriParam")) + .doesNotContain("@Pattern(regexp=\"^https?://\")") + .doesNotContain("@Size"); + assertThat(getKotlinParameterAnnotations(api, "uriParamMaxLength")).doesNotContain("@Size"); + assertThat(getKotlinParameterAnnotations(api, "uriParamMinMaxLength")).doesNotContain("@Size"); + assertThat(getKotlinParameterAnnotations(api, "plainStringParam")) + .contains("@Pattern(regexp=\"^[a-z]+$\")") + .contains("@Size(min=1)"); + assertThat(getKotlinParameterAnnotations(api, "plainStringParamMaxLength")).contains("@Size(max=10)"); + assertThat(getKotlinParameterAnnotations(api, "plainStringParamMinMaxLength")) + .contains("@Size(min=2,max=12)"); + } + + private String getKotlinPropertyAnnotations(String model, String propertyName) { + String declaration = "val " + propertyName + ":"; + int declarationIndex = model.indexOf(declaration); + assertThat(declarationIndex).as("property declaration for %s", propertyName).isGreaterThanOrEqualTo(0); + + int previousPropertyIndex = model.lastIndexOf("val ", declarationIndex - 1); + int annotationsStart; + if (previousPropertyIndex >= 0) { + annotationsStart = model.indexOf('\n', previousPropertyIndex) + 1; + } else { + int classDeclarationIndex = model.lastIndexOf("data class ", declarationIndex); + annotationsStart = model.indexOf('\n', classDeclarationIndex) + 1; + } + return model.substring(annotationsStart, declarationIndex); + } + + private String getKotlinParameterAnnotations(String api, String parameterName) { + String declaration = parameterName + ":"; + int declarationIndex = api.indexOf(declaration); + assertThat(declarationIndex).as("parameter declaration for %s", parameterName).isGreaterThanOrEqualTo(0); + + int lineStart = api.lastIndexOf('\n', declarationIndex) + 1; + return api.substring(lineStart, declarationIndex); + } + /** * Regression test for https://github.com/OpenAPITools/openapi-generator/issues/24139 diff --git a/modules/openapi-generator/src/test/resources/3_0/kotlin/uri-validation-pattern.yaml b/modules/openapi-generator/src/test/resources/3_0/kotlin/uri-validation-pattern.yaml new file mode 100644 index 000000000000..7952eb5d4282 --- /dev/null +++ b/modules/openapi-generator/src/test/resources/3_0/kotlin/uri-validation-pattern.yaml @@ -0,0 +1,83 @@ +openapi: 3.0.3 +info: + title: URI validation annotations + version: 1.0.0 +paths: + /uri-payload: + get: + operationId: getUriPayload + parameters: + - in: query + name: uriParam + schema: + type: string + format: uri + pattern: '^https?://' + minLength: 1 + - in: query + name: uriParamMaxLength + schema: + type: string + format: uri + maxLength: 10 + - in: query + name: uriParamMinMaxLength + schema: + type: string + format: uri + minLength: 2 + maxLength: 12 + - in: query + name: plainStringParam + schema: + type: string + pattern: '^[a-z]+$' + minLength: 1 + - in: query + name: plainStringParamMaxLength + schema: + type: string + maxLength: 10 + - in: query + name: plainStringParamMinMaxLength + schema: + type: string + minLength: 2 + maxLength: 12 + responses: + '200': + description: URI payload + content: + application/json: + schema: + $ref: '#/components/schemas/UriPayload' +components: + schemas: + UriPayload: + type: object + properties: + uri: + type: string + format: uri + pattern: '^https?://' + minLength: 1 + plainString: + type: string + pattern: '^[a-z]+$' + minLength: 1 + uriMaxLength: + type: string + format: uri + maxLength: 10 + uriMinMaxLength: + type: string + format: uri + minLength: 2 + maxLength: 12 + plainStringMaxLength: + type: string + maxLength: 10 + plainStringMinMaxLength: + type: string + minLength: 2 + maxLength: 12