Skip to content

REL: Remove bad_request Changeset Fn Clause #128

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

REL: Remove bad_request Changeset Fn Clause #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 14 additions & 10 deletions lib/response.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,17 @@ defmodule Solicit.Response do

# 400
@doc """
Signifies a bad request.
The server cannot or will not process the request due to something that is perceived to be a client error
(e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

This should only be used if we can't parse the incoming json/xml payloads because there are syntactic errors in those
payloads.

Phoenix Framework more or less rejects these messages before they reach the router itself so this may
actually never be needed.

For bad user input that can be retried, check out 422 Unprocessable Entity.
For user requests that cannot be retried, check out 409 Conflict.
"""
@spec bad_request(Plug.Conn.t()) :: Plug.Conn.t()
def bad_request(conn) do
Expand All @@ -91,14 +101,6 @@ defmodule Solicit.Response do
|> halt()
end

@spec bad_request(Plug.Conn.t(), Ecto.Changeset.t()) :: Plug.Conn.t()
def bad_request(conn, %Ecto.Changeset{} = changeset) do
conn
|> put_status(:bad_request)
|> json(%{errors: ResponseError.from_changeset(changeset)})
|> halt()
end

@spec bad_request(Plug.Conn.t(), binary()) :: Plug.Conn.t()
def bad_request(conn, message) do
conn
Expand Down Expand Up @@ -296,7 +298,9 @@ defmodule Solicit.Response do

# 422
@doc """
Signifies an unprocessable_entity response.
The request was well-formed, but was unable to be followed due to semantic errors.

Examples: The request cannot be completed because the JSON payload is missing `email`, a required field.
"""
@spec unprocessable_entity(
Plug.Conn.t(),
Expand Down