#40 Added support for operation deprecation

core/src/main/kotlin/org/taymyr/lagom/internal/openapi/OperationMethodProcessor.kt

@@ -137,6 +137,7 @@ object OperationMethodProcessor {
             operation.description(annotation.description.ifBlank { null })
             operation.operationId(annotation.operationId.ifBlank { null })
             operation.summary(annotation.summary.ifBlank { null })
+            operation.deprecated(annotation.deprecated.takeIf { annotation.deprecated })
             operation.externalDocs(
                 AnnotationsUtils.getExternalDocumentation(annotation.externalDocs)
                     .orElse(AnnotationsUtils.getExternalDocumentation(classInfo.externalDocumentation)

core/src/test/java/org/taymyr/lagom/internal/openapi/OpenAPITest.java

@@ -5,6 +5,7 @@
 import org.junit.jupiter.api.Test;
 import org.taymyr.lagom.internal.openapi.cases.ArrayParameterService;
 import org.taymyr.lagom.internal.openapi.cases.ClassHiddenService;
+import org.taymyr.lagom.internal.openapi.cases.DeprecatedOperationService;
 import org.taymyr.lagom.internal.openapi.cases.LinksService;
 import org.taymyr.lagom.internal.openapi.cases.OpenAPIDefinitionService;
 import org.taymyr.lagom.internal.openapi.cases.ParameterService;
@@ -50,6 +51,17 @@ void testParameterService() throws NoSuchMethodException {
         );
     }
 
+    @Test
+    @DisplayName("Test service with a deprecated operation")
+    void testDeprecatedOperationService() throws NoSuchMethodException {
+        checkOpenAPISpec(
+            new LagomServiceInfo(DeprecatedOperationService.class, ImmutableList.of(
+                new LagomCallInfo(DeprecatedOperationService.class.getDeclaredMethod("test", String.class), "/test/{id}", "GET")
+            )),
+            "DeprecatedOperationService.yml"
+        );
+    }
+
     @Test
     @DisplayName("Test service with array parameters")
     void testArrayParameterService() throws NoSuchMethodException {

core/src/test/java/org/taymyr/lagom/internal/openapi/cases/DeprecatedOperationService.java

@@ -0,0 +1,50 @@
+package org.taymyr.lagom.internal.openapi.cases;
+
+import akka.NotUsed;
+import com.lightbend.lagom.javadsl.api.Descriptor;
+import com.lightbend.lagom.javadsl.api.Service;
+import com.lightbend.lagom.javadsl.api.ServiceCall;
+import com.lightbend.lagom.javadsl.api.transport.Method;
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.enums.ParameterStyle;
+import io.swagger.v3.oas.annotations.info.Info;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+import static com.lightbend.lagom.javadsl.api.Service.named;
+import static com.lightbend.lagom.javadsl.api.Service.restCall;
+
+@OpenAPIDefinition(
+    info = @Info(title = "Test", version = "1.0.0", description = "Description")
+)
+public interface DeprecatedOperationService extends Service {
+
+    @Operation(
+        deprecated = true,
+        parameters = {
+            @Parameter(
+                in = ParameterIn.PATH,
+                name = "id",
+                required = true,
+                description = "parameter description",
+                allowReserved = true,
+                style = ParameterStyle.SIMPLE,
+                schema = @Schema(
+                    type = "string",
+                    format = "uuid",
+                    description = "the generated UUID",
+                    accessMode = Schema.AccessMode.READ_ONLY)
+            )}
+    )
+    ServiceCall<NotUsed, NotUsed> test(String id);
+
+    @Override
+    default Descriptor descriptor() {
+        return named("test").withCalls(
+            restCall(Method.GET, "/test/:id", this::test)
+        );
+    }
+
+}

core/src/test/resources/DeprecatedOperationService.yml

@@ -0,0 +1,24 @@
+openapi: 3.0.1
+info:
+  title: Test
+  description: Description
+  version: 1.0.0
+paths:
+  /test/{id}:
+    get:
+      deprecated: true
+      operationId: test
+      parameters:
+        - name: id
+          in: path
+          description: parameter description
+          required: true
+          style: simple
+          allowReserved: true
+          schema:
+            type: string
+            description: the generated UUID
+            format: uuid
+            readOnly: true
+      responses: {}
+components: {}