[kotlin] Support @Deprecation annotation for kotlin-spring generator (#23104)

* Add change to template with tests

* Update test

* Add required message attribute for Kotlin code

* Regenerate samples

Author: eugeniyk

modules/openapi-generator/src/main/resources/kotlin-spring/api.mustache

@@ -87,6 +87,9 @@ class {{classname}}Controller({{#serviceInterface}}@Autowired(required = true) v
     {{#vendorExtensions.x-operation-extra-annotation}}
     {{{.}}}
     {{/vendorExtensions.x-operation-extra-annotation}}
+    {{#isDeprecated}}
+    @Deprecated(message="Operation is deprecated")
+    {{/isDeprecated}}
     @RequestMapping(
         method = [RequestMethod.{{httpMethod}}],
         // "{{#lambdaEscapeInNormalString}}{{{path}}}{{/lambdaEscapeInNormalString}}"

modules/openapi-generator/src/main/resources/kotlin-spring/apiInterface.mustache

@@ -102,6 +102,9 @@ interface {{classname}} {
     {{#vendorExtensions.x-operation-extra-annotation}}
     {{{.}}}
     {{/vendorExtensions.x-operation-extra-annotation}}
+    {{#isDeprecated}}
+    @Deprecated(message="Operation is deprecated")
+    {{/isDeprecated}}
     @RequestMapping(
         method = [RequestMethod.{{httpMethod}}],
         // "{{#lambdaEscapeInNormalString}}{{{path}}}{{/lambdaEscapeInNormalString}}"

modules/openapi-generator/src/main/resources/kotlin-spring/service.mustache

@@ -30,6 +30,9 @@ interface {{classname}}Service {
     {{/externalDocs}}
      * @see {{classname}}#{{operationId}}
      */
+    {{#isDeprecated}}
+    @Deprecated(message="Operation is deprecated")
+    {{/isDeprecated}}
     {{#reactive}}{{^isArray}}suspend {{/isArray}}{{#isArray}}{{^useFlowForArrayReturnType}}suspend {{/useFlowForArrayReturnType}}{{/isArray}}{{/reactive}}fun {{operationId}}({{#allParams}}{{{paramName}}}: {{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{>optionalDataType}}{{/reactive}}{{#reactive}}{{^isArray}}{{>optionalDataType}}{{/isArray}}{{#isArray}}Flow<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{^-last}}, {{/-last}}{{/allParams}}): {{>returnTypes}}
 {{/operation}}
 }

modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java

@@ -4663,6 +4663,49 @@ public void testSealedResponseInterfacesVoidResponse() throws IOException {
         Assert.assertTrue(petContent.contains(") : CreatePetResponse {") || petContent.contains(") : CreatePetResponse"),
                 "Pet should implement CreatePetResponse");
     }
+
+    @Test
+    public void testDeprecatedAnnotationOnInterface() throws IOException {
+        File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
+        output.deleteOnExit();
+        String outputPath = output.getAbsolutePath().replace('\\', '/');
+
+        KotlinSpringServerCodegen codegen = new KotlinSpringServerCodegen();
+        codegen.setOutputDir(output.getAbsolutePath());
+        codegen.additionalProperties().put(CodegenConstants.API_PACKAGE, "org.openapitools.api");
+        codegen.additionalProperties().put(KotlinSpringServerCodegen.INTERFACE_ONLY, true);
+
+        new DefaultGenerator().opts(new ClientOptInput()
+                        .openAPI(TestUtils.parseSpec("src/test/resources/3_0/kotlin/support-deprecated-api.yaml"))
+                        .config(codegen))
+                .generate();
+
+        assertFileContains(
+                Paths.get(outputPath + "/src/main/kotlin/org/openapitools/api/PingApi.kt"),
+                "@Deprecated(message=\"Operation is deprecated\") @RequestMapping("
+        );
+    }
+
+    @Test
+    public void testDeprecatedAnnotationOnController() throws IOException {
+        File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
+        output.deleteOnExit();
+        String outputPath = output.getAbsolutePath().replace('\\', '/');
+
+        KotlinSpringServerCodegen codegen = new KotlinSpringServerCodegen();
+        codegen.setOutputDir(output.getAbsolutePath());
+        codegen.additionalProperties().put(CodegenConstants.API_PACKAGE, "org.openapitools.api");
+
+        new DefaultGenerator().opts(new ClientOptInput()
+                        .openAPI(TestUtils.parseSpec("src/test/resources/3_0/kotlin/support-deprecated-api.yaml"))
+                        .config(codegen))
+                .generate();
+
+        assertFileContains(
+                Paths.get(outputPath + "/src/main/kotlin/org/openapitools/api/PingApiController.kt"),
+                "@Deprecated(message=\"Operation is deprecated\") @RequestMapping("
+        );
+    }
 }
 
 

modules/openapi-generator/src/test/resources/3_0/kotlin/support-deprecated-api.yaml

@@ -0,0 +1,14 @@
+openapi: "3.0.0"
+info:
+  title: Verify @Deprecated annotation
+  version: "1.0"
+
+paths:
+
+  /ping:
+    get:
+      deprecated: true
+      operationId: ping
+      responses:
+        200:
+          description: OK

samples/server/petstore/kotlin-spring-cloud/src/main/kotlin/org/openapitools/api/PetApi.kt

@@ -73,6 +73,7 @@ interface PetApi {
     }
 
 
+    @Deprecated(message="Operation is deprecated")
     @RequestMapping(
         method = [RequestMethod.GET],
         // "/pet/findByTags"

samples/server/petstore/kotlin-spring-default/src/main/kotlin/org/openapitools/api/PetApiController.kt

@@ -106,6 +106,7 @@ class PetApiController() {
             ApiResponse(responseCode = "400", description = "Invalid tag value") ],
         security = [ SecurityRequirement(name = "petstore_auth", scopes = [ "read:pets" ]) ]
     )
+    @Deprecated(message="Operation is deprecated")
     @RequestMapping(
         method = [RequestMethod.GET],
         // "/pet/findByTags"

samples/server/petstore/kotlin-spring-sealed-interfaces/src/main/kotlin/org/openapitools/api/PetApi.kt

@@ -78,6 +78,7 @@ interface PetApi {
     }
 
 
+    @Deprecated(message="Operation is deprecated")
     @RequestMapping(
         method = [RequestMethod.GET],
         // "/pet/findByTags"

samples/server/petstore/kotlin-springboot-3-no-response-entity/src/main/kotlin/org/openapitools/api/PetApiController.kt

@@ -69,6 +69,7 @@ class PetApiController(@Autowired(required = true) val service: PetApiService) {
     }
 
 
+    @Deprecated(message="Operation is deprecated")
     @RequestMapping(
         method = [RequestMethod.GET],
         // "/pet/findByTags"

samples/server/petstore/kotlin-springboot-3-no-response-entity/src/main/kotlin/org/openapitools/api/PetApiService.kt

@@ -48,6 +48,7 @@ interface PetApiService {
      * @deprecated
      * @see PetApi#findPetsByTags
      */
+    @Deprecated(message="Operation is deprecated")
     fun findPetsByTags(tags: kotlin.collections.List<kotlin.String>): List<Pet>
 
     /**