forked from orbit-oss/flask
Fixed the docs for the request object. They were incomplete
This commit is contained in:
parent
b34b086543
commit
153d727d1f
1 changed files with 16 additions and 14 deletions
30
docs/api.rst
30
docs/api.rst
|
|
@ -29,20 +29,7 @@ Incoming Request Data
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
.. autoclass:: Request
|
.. autoclass:: Request
|
||||||
|
:members:
|
||||||
.. class:: request
|
|
||||||
|
|
||||||
To access incoming request data, you can use the global `request`
|
|
||||||
object. Flask parses incoming request data for you and gives you
|
|
||||||
access to it through that global object. Internally Flask makes
|
|
||||||
sure that you always get the correct data for the active thread if you
|
|
||||||
are in a multithreaded environment.
|
|
||||||
|
|
||||||
This is a proxy. See :ref:`notes-on-proxies` for more information.
|
|
||||||
|
|
||||||
The request object is an instance of a :class:`~werkzeug.wrappers.Request`
|
|
||||||
subclass and provides all of the attributes Werkzeug defines. This
|
|
||||||
just shows a quick overview of the most important ones.
|
|
||||||
|
|
||||||
.. attribute:: form
|
.. attribute:: form
|
||||||
|
|
||||||
|
|
@ -134,6 +121,21 @@ Incoming Request Data
|
||||||
the incoming data was `application/json`. This requires Python 2.6
|
the incoming data was `application/json`. This requires Python 2.6
|
||||||
or an installed version of simplejson.
|
or an installed version of simplejson.
|
||||||
|
|
||||||
|
.. class:: request
|
||||||
|
|
||||||
|
To access incoming request data, you can use the global `request`
|
||||||
|
object. Flask parses incoming request data for you and gives you
|
||||||
|
access to it through that global object. Internally Flask makes
|
||||||
|
sure that you always get the correct data for the active thread if you
|
||||||
|
are in a multithreaded environment.
|
||||||
|
|
||||||
|
This is a proxy. See :ref:`notes-on-proxies` for more information.
|
||||||
|
|
||||||
|
The request object is an instance of a :class:`~werkzeug.wrappers.Request`
|
||||||
|
subclass and provides all of the attributes Werkzeug defines. This
|
||||||
|
just shows a quick overview of the most important ones.
|
||||||
|
|
||||||
|
|
||||||
Response Objects
|
Response Objects
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue