Merge pull request rails#46752 from swanson/forgery-docs-update

jonathanhefner · web-flow · commit 40b1c6087282 · 2022-12-16T11:21:48.000-06:00
Update RequestForgeryProtection docs to encourage wrapper method for skipping [ci-skip]
diff --git a/actionpack/lib/action_controller/metal/request_forgery_protection.rb b/actionpack/lib/action_controller/metal/request_forgery_protection.rb
@@ -111,9 +111,11 @@ module ClassMethods
       #     protect_from_forgery except: :index
       #   end
       #
-      # You can disable forgery protection on controller by skipping the verification before_action:
+      # You can disable forgery protection on a controller using skip_forgery_protection:
       #
-      #   skip_before_action :verify_authenticity_token
+      #   class BarController < ApplicationController
+      #     skip_forgery_protection
+      #   end
       #
       # Valid Options:
       #

Original file line number	Diff line number	Diff line change
`@@ -111,9 +111,11 @@ module ClassMethods`
`111`	`111`	`# protect_from_forgery except: :index`
`112`	`112`	`# end`
`113`	`113`	`#`
`114`		`- # You can disable forgery protection on controller by skipping the verification before_action:`
	`114`	`+ # You can disable forgery protection on a controller using skip_forgery_protection:`
`115`	`115`	`#`
`116`		`- # skip_before_action :verify_authenticity_token`
	`116`	`+ # class BarController < ApplicationController`
	`117`	`+ # skip_forgery_protection`
	`118`	`+ # end`
`117`	`119`	`#`
`118`	`120`	`# Valid Options:`
`119`	`121`	`#`