Packages
eview
0.15.0
0.16.0
retired
0.15.0
0.14.0
0.13.0
0.12.5
0.12.4
0.12.3
0.12.2
0.12.1
0.12.0
0.11.1
0.11.0
0.10.8
0.10.7
0.10.6
0.10.5
0.10.4
0.10.3
0.10.2
0.10.1
0.10.0
0.9.7
0.9.6
0.9.5
0.9.4
0.9.3
0.9.2
0.9.0
0.8.2
0.8.1
0.8.0
0.7.1
0.7.0
0.6.0
0.5.2
0.5.1
0.5.0
0.4.0
0.3.0
0.2.9
0.2.7
0.2.6
0.2.5
0.2.3
0.2.2
0.2.1
0.2.0
0.1.1
0.1.0
Plug that converts response to Nebo #15 API spec format.
Current section
Files
Jump to
Current section
Files
lib/eview/views/validation_error_view.ex
defmodule EView.Views.ValidationError do
@moduledoc """
This module provides renders that can be used whenever you want to show validation error.
# Example:
changeset = %SampleSchema{}
|> SampleSchema.changeset(params)
case changeset.valid? do
true ->
conn
|> put_status(200)
|> render("page.json", map_keys_to_atom(params))
_ ->
conn
|> put_status(422)
|> render(EView.Views.ValidationError, "422.json", changeset)
end
"""
if Code.ensure_loaded?(Ecto) do
@doc """
Use this render template whenever you want to return validation error. Currently is supports:
* `Ecto.Changeset` errors (you can pass Schema that failed validation or changeset by itself);
* `ex_json_schema` validation errors.
"""
def render("422.json", %Ecto.Changeset{} = ch), do: render("422.json", ch, "json_data_property")
def render("422.json", %{changeset: ch}), do: render("422.json", ch)
def render("422.query.json", %Ecto.Changeset{} = ch), do: render("422.json", ch, "query_parameter")
def render("422.query.json", %{changeset: ch}), do: render("422.json", ch, "query_parameter")
def render("422.query.json", %{schema: errors} = params) when is_list(errors) do
render("422.json", params, "query_parameter")
end
def render("422.json", %Ecto.Changeset{} = changeset, entry_type) do
%{
type: :validation_failed,
invalid: EView.Helpers.ChangesetValidationsParser.changeset_to_rules(changeset, entry_type),
message:
"Validation failed. You can find validators description at our API Manifest: " <>
"http://docs.apimanifest.apiary.io/#introduction/interacting-with-api/errors."
}
end
end
if Code.ensure_loaded?(NExJsonSchema) do
@doc """
Render a JSON Schema validation error.
"""
def render("422.json", %{schema: errors}, entry_type \\ "json_data_property") when is_list(errors) do
errors =
errors
|> Enum.map(&map_schema_errors(&1, entry_type))
%{
type: :validation_failed,
invalid: errors,
message:
"Validation failed. You can find validators description at our API Manifest: " <>
"http://docs.apimanifest.apiary.io/#introduction/interacting-with-api/errors."
}
end
defp map_schema_errors({rule, path}, entry_type) do
%{
entry_type: entry_type,
entry: path,
rules: [EView.Helpers.Sanitizer.sanitize(rule)]
}
end
end
end