summaryrefslogtreecommitdiff
path: root/docs/narr/introspector.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2016-06-01 17:13:27 -0400
committerChris McDonough <chrism@plope.com>2016-06-01 17:13:27 -0400
commit3e9a737500e79a6a919ce53db9557c75d874b84c (patch)
treeef674c176ab29b9dede8a8fa70c3a18a26edde44 /docs/narr/introspector.rst
parentb5f065906f75efdcc9f80d4f0b8b4092e92b41c0 (diff)
parent382f93e2bfec5563587e306fda3fd34759314300 (diff)
downloadpyramid-3e9a737500e79a6a919ce53db9557c75d874b84c.tar.gz
pyramid-3e9a737500e79a6a919ce53db9557c75d874b84c.tar.bz2
pyramid-3e9a737500e79a6a919ce53db9557c75d874b84c.zip
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'docs/narr/introspector.rst')
-rw-r--r--docs/narr/introspector.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/narr/introspector.rst b/docs/narr/introspector.rst
index 98315ac9f..c9fecd4f4 100644
--- a/docs/narr/introspector.rst
+++ b/docs/narr/introspector.rst
@@ -337,6 +337,31 @@ introspectables in categories not described here.
The permission name passed to ``set_default_permission``.
+``default csrf options``
+
+ There will be one and only one introspectable in the ``default csrf options``
+ category. It represents a call to the
+ :meth:`pyramid.config.Configurator.set_default_csrf_options` method. It
+ will have the following data.
+
+ ``require_csrf``
+
+ The default value for ``require_csrf`` if left unspecified on calls to
+ :meth:`pyramid.config.Configurator.add_view`.
+
+ ``token``
+
+ The name of the token searched in ``request.POST`` to find a valid CSRF
+ token.
+
+ ``header``
+
+ The name of the request header searched to find a valid CSRF token.
+
+ ``safe_methods``
+
+ The list of HTTP methods considered safe and exempt from CSRF checks.
+
``views``
Each introspectable in the ``views`` category represents a call to