Skip to content
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

Add notice that body params are not merged into Conn.params whne using cast and validate plug #589

Merged
merged 1 commit into from
May 12, 2024
Merged

Add notice that body params are not merged into Conn.params whne using cast and validate plug #589

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
2 changes: 2 additions & 0 deletions lib/open_api_spex/plug/cast_and_validate.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
defmodule OpenApiSpex.Plug.CastAndValidate do
@moduledoc """
Module plug that will cast and validate the `Conn.params` and `Conn.body_params` according to the schemas defined for the operation.
Note that when using this plug, the body params are no longer merged into `Conn.params` and must be read from `Conn.body_params`
separately.

The operation_id can be given at compile time as an argument to `init`:

Expand Down