Skip to content

fix: support RequestBody passed to operation macro #456

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.

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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion lib/open_api_spex/operation_builder.ex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule OpenApiSpex.OperationBuilder do
@moduledoc false

alias OpenApiSpex.{ExternalDocumentation, Operation, Parameter, Reference, Response}
alias OpenApiSpex.{ExternalDocumentation, Operation, Parameter, Reference, RequestBody, Response}
alias Plug.Conn.Status

def ensure_type_and_schema_exclusive!(name, type, schema) do
Expand Down Expand Up @@ -114,6 +114,8 @@ defmodule OpenApiSpex.OperationBuilder do
Operation.request_body(description, media_type, schema)
end

def build_request_body(%{request_body: %RequestBody{} = request_body}), do: request_body

def build_request_body(%{request_body: {description, media_type, schema}}) do
Operation.request_body(description, media_type, schema)
end
Expand Down
42 changes: 42 additions & 0 deletions test/controller_specs_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ defmodule OpenApiSpex.ControllerSpecsTest do

alias OpenApiSpex.{MediaType, RequestBody, Response}
alias OpenApiSpexTest.DslController
alias OpenApiSpexTest.DslControllerOperationStructs

describe "operation/1" do
test "supports :parameters" do
Expand Down Expand Up @@ -66,6 +67,47 @@ defmodule OpenApiSpex.ControllerSpecsTest do
assert media_type.example == "text example"
end

test "supports Parameter, RequestBody and Response structs" do
assert %OpenApiSpex.Operation{
summary: "Update user",
requestBody: request_body,
responses: responses
} = DslControllerOperationStructs.open_api_operation(:update)

assert %{200 => response} = responses

assert %Response{
content: content,
description: "User response",
headers: %{"content-type" => %OpenApiSpex.Header{}}
} = response

assert %{
"application/json" => %MediaType{
schema: OpenApiSpexTest.DslController.UserResponse,
example: "json example response"
},
"application/text" => %MediaType{
schema: OpenApiSpexTest.DslController.UserResponse,
example: "text example response"
}
} = content

assert %RequestBody{
content: %{
"application/json" => %MediaType{
schema: OpenApiSpexTest.DslController.UserParams,
example: "json example request"
},
"application/text" => %MediaType{
schema: OpenApiSpexTest.DslController.UserParams,
example: "text example request"
}
},
description: "User params"
} = request_body
end

test ":deprecated" do
assert %OpenApiSpex.Operation{
summary: "User destroy",
Expand Down
58 changes: 58 additions & 0 deletions test/support/dsl_controller_operation_structs.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
defmodule OpenApiSpexTest.DslControllerOperationStructs do
use Phoenix.Controller
use OpenApiSpex.ControllerSpecs

alias OpenApiSpex.Operation

alias OpenApiSpexTest.DslController

tags ["users"]

security [%{"api_key" => ["mySecurityScheme"]}]

operation :update,
summary: "Update user",
parameters: [
Operation.parameter(:id, :path, :integer, "User ID", example: 1001)
],
request_body:
Operation.request_body(
"User params",
%{
"application/json" => [example: "json example request"],
"application/text" => [example: "text example request"]
},
DslController.UserParams
),
responses: [
ok:
Operation.response(
"User response",
%{
"application/json" => [example: "json example response"],
"application/text" => [example: "text example response"]
},
DslController.UserResponse,
headers: %{
"content-type" => %OpenApiSpex.Header{
description: "Type of the content for the response",
example: "content-type: application/json; charset=utf-8"
}
}
)
],
tags: ["custom"],
security: [%{"two" => ["another"]}]

def update(conn, %{"id" => id}) do
conn
|> put_resp_header("content-type", "application/json; charset=utf-8")
|> json(%{
data: %{
id: id,
name: "joe user",
email: "joe@gmail.com"
}
})
end
end