Merge pull request rails#49374 from yykamei/add_doc_for_protect_from_forgery

rafaelfranca · web-flow · commit 180e60119602 · 2023-09-29T16:13:02.000-04:00
Add notice to documentation for protect_from_forgery's :with option
diff --git a/actionpack/lib/action_controller/metal/request_forgery_protection.rb b/actionpack/lib/action_controller/metal/request_forgery_protection.rb
@@ -125,6 +125,7 @@ module ClassMethods
       #
       #   If you need to add verification to the beginning of the callback chain, use <tt>prepend: true</tt>.
       # * <tt>:with</tt> - Set the method to handle unverified request.
+      #   Note if <tt>default_protect_from_forgery</tt> is true, Rails call protect_from_forgery with <tt>with :exception</tt>.
       #
       # Built-in unverified request handling methods are:
       # * <tt>:exception</tt> - Raises ActionController::InvalidAuthenticityToken exception.

Original file line number	Diff line number	Diff line change
`@@ -125,6 +125,7 @@ module ClassMethods`
`125`	`125`	`#`
`126`	`126`	`# If you need to add verification to the beginning of the callback chain, use <tt>prepend: true</tt>.`
`127`	`127`	`# * <tt>:with</tt> - Set the method to handle unverified request.`
	`128`	`+ # Note if <tt>default_protect_from_forgery</tt> is true, Rails call protect_from_forgery with <tt>with :exception</tt>.`
`128`	`129`	`#`
`129`	`130`	`# Built-in unverified request handling methods are:`
`130`	`131`	`# * <tt>:exception</tt> - Raises ActionController::InvalidAuthenticityToken exception.`