ControllerSpecs add support for deprecated

lib/open_api_spex/controller_specs.ex

@@ -262,6 +262,7 @@ defmodule OpenApiSpex.ControllerSpecs do
 
     %Operation{
       description: Map.get(spec, :description),
+      deprecated: Map.get(spec, :deprecated),
       operationId: OperationBuilder.build_operation_id(spec, module, action),
       parameters: OperationBuilder.build_parameters(spec),
       requestBody: OperationBuilder.build_request_body(spec),

test/controller_specs_test.exs

@@ -56,6 +56,13 @@ defmodule OpenApiSpex.ControllerSpecsTest do
       assert %MediaType{schema: OpenApiSpexTest.DslController.UserResponse} = media_type
     end
 
+    test ":deprecated" do
+      assert %OpenApiSpex.Operation{
+               summary: "User destroy",
+               deprecated: true
+             } = DslController.open_api_operation(:destroy)
+    end
+
     test "outputs warning when action not defined for called open_api_operation" do
       output = capture_io(:stderr, fn -> DslController.open_api_operation(:undefined) end)
 

test/support/dsl_controller.ex

@@ -46,6 +46,15 @@ defmodule OpenApiSpexTest.DslController do
     })
   end
 
+  defmodule UsersDestroyResponse do
+    alias OpenApiSpex.Schema
+    require OpenApiSpex
+
+    OpenApiSpex.schema(%{
+      type: :string
+    })
+  end
+
   tags ["users"]
 
   security [%{"api_key" => ["mySecurityScheme"]}]
@@ -93,4 +102,22 @@ defmodule OpenApiSpexTest.DslController do
   def index(conn, _) do
     json(conn, [])
   end
+
+  operation :destroy,
+    deprecated: true,
+    summary: "User destroy",
+    parameters: [
+      username: [
+        in: :query,
+        description: "Username to destroy",
+        type: :string
+      ]
+    ],
+    responses: [
+      no_content: {"Users destroy response", "application/json", UsersDestroyResponse}
+    ]
+
+  def index(conn, _) do
+    json(conn, [])
+  end
 end