summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2009-01-12 05:12:57 +0000
committerChris McDonough <chrism@agendaless.com>2009-01-12 05:12:57 +0000
commita0b40cc8aa58c557c30840c906fcba3401bb91cf (patch)
tree9c1b94a971f7394f42aed7e16b7ba49248bb7d47 /docs/index.rst
parentb16527306a1ddd0ed5c0a9db78a8ffa64c42ae2e (diff)
downloadpyramid-a0b40cc8aa58c557c30840c906fcba3401bb91cf.tar.gz
pyramid-a0b40cc8aa58c557c30840c906fcba3401bb91cf.tar.bz2
pyramid-a0b40cc8aa58c557c30840c906fcba3401bb91cf.zip
- An interface specific to the HTTP verb (GET/PUT/POST/DELETE/HEAD) is
attached to each request object on ingress. The HTTP-verb-related interfaces are defined in ``repoze.bfg.interfaces`` and are ``IGETRequest``, ``IPOSTRequest``, ``IPUTRequest``, ``IDELETERequest`` and ``IHEADRequest``. These interfaces can be specified as the ``request_type`` attribute of a bfg view declaration. A view naming a specific HTTP-verb-matching interface will be found only if the view is defined with a request_type that matches the HTTP verb in the incoming request. The more general ``IRequest`` interface can be used as the request_type to catch all requests (and this is indeed the default). All requests implement ``IRequest``. The HTTP-verb-matching idea was pioneered by `repoze.bfg.restrequest <http://pypi.python.org/pypi/repoze.bfg.restrequest/1.0.1>`_ . That package is no longer required, but still functions fine.
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 917bf8fe4..13edb8a48 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -47,6 +47,7 @@ Per-module :mod:`repoze.bfg` API documentation.
:maxdepth: 2
api/events
+ api/interfaces
api/push
api/router
api/security