Update doc for header to use headers object from connexion.

This commit is contained in:
Arjun Naik
2016-03-17 14:55:15 +01:00
parent 27077a4440
commit c9b6acafdb

View File

@@ -92,10 +92,10 @@ supports collection formats "pipes" and "csv". The default format is "csv".
Header Parameters
-----------------
Currently header parameters are not passed to the handler functions. But they can be accessed through the underlying
``flask.request.headers`` object.
Currently header parameters are not passed to the handler functions as parameters. But they can be accessed through the underlying
``connexion.request.headers`` object which aliases the ``flask.request.headers`` object.
.. code-block:: python
def index():
page_number = flask.requests.headers['Page-Number']
page_number = connexion.request.headers['Page-Number']