summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael Merickel <michael@digitalartefacts.com>2013-10-19 01:37:11 -0500
committerMichael Merickel <michael@digitalartefacts.com>2013-10-19 01:37:11 -0500
commit7fd86623a0d77d390980c5dc09f49dde2f781091 (patch)
tree71375e2fa9c74a5289ce21cf7f5442acc0da5e76 /docs
parent3acee31f86bcde8abbb4e63715afc5ca67976eaf (diff)
parent0905d2015e35e827c3fdb2135695710b80d549a5 (diff)
downloadpyramid-7fd86623a0d77d390980c5dc09f49dde2f781091.tar.gz
pyramid-7fd86623a0d77d390980c5dc09f49dde2f781091.tar.bz2
pyramid-7fd86623a0d77d390980c5dc09f49dde2f781091.zip
Merge branch 'check_csrf_token' of kpinc/pyramid into feature.bad-csrf-token-exception
Diffstat (limited to 'docs')
-rw-r--r--docs/api/httpexceptions.rst19
1 files changed, 16 insertions, 3 deletions
diff --git a/docs/api/httpexceptions.rst b/docs/api/httpexceptions.rst
index 6a08d1048..0fdd0f0e9 100644
--- a/docs/api/httpexceptions.rst
+++ b/docs/api/httpexceptions.rst
@@ -7,9 +7,12 @@
.. attribute:: status_map
- A mapping of integer status code to exception class (eg. the
- integer "401" maps to
- :class:`pyramid.httpexceptions.HTTPUnauthorized`).
+ A mapping of integer status code to HTTP exception class (eg. the integer
+ "401" maps to :class:`pyramid.httpexceptions.HTTPUnauthorized`). All
+ mapped exception classes are children of :class:`pyramid.httpexceptions`,
+ i.e. the :ref:`pyramid_specific_http_exceptions` such as
+ :class:`pyramid.httpexceptions.HTTPBadRequest.BadCSRFToken` are not
+ mapped.
.. autofunction:: exception_response
@@ -106,3 +109,13 @@
.. autoclass:: HTTPVersionNotSupported
.. autoclass:: HTTPInsufficientStorage
+
+
+.. _pyramid_specific_http_exceptions:
+
+Pyramid-specific HTTP Exceptions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Each Pyramid-specific HTTP exception has the status code of it's parent.
+
+ .. autoclass:: HTTPBadCSRFToken