Skip to content

Update docs according to #215 #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 10, 2019
Merged

Update docs according to #215 #216

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edf4919
Update docs according to c5f32c337d8d191e93ab80152640090ddb664639
illia-v Dec 26, 2018
5921c81
Merge branch 'master' into more-allowed-data-structures-docs
illia-v Jan 3, 2019
ae2dad8
Change default value of `JWT_TOKEN_LOCATION` to list in documentation
illia-v Jan 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ General Options:
================================= =========================================
``JWT_TOKEN_LOCATION`` Where to look for a JWT when processing a request. The
options are ``'headers'``, ``'cookies'``, ``'query_string'``, or ``'json'``. You can pass
in a list to check more then one location, such as: ``['headers', 'cookies']``.
Defaults to ``'headers'``
in a sequence or a set to check more then one location, such as:
``('headers', 'cookies')``. Defaults to ``['headers']``
``JWT_ACCESS_TOKEN_EXPIRES`` How long an access token should live before it expires. This
takes a ``datetime.timedelta``, and defaults to 15 minutes.
Can be set to ``False`` to disable expiration.
Expand Down Expand Up @@ -160,7 +160,7 @@ Blacklist Options:
================================= =========================================
``JWT_BLACKLIST_ENABLED`` Enable/disable token revoking. Defaults to ``False``
``JWT_BLACKLIST_TOKEN_CHECKS`` What token types to check against the blacklist. The options are
``'refresh'`` or ``'access'``. You can pass in a list to check
more then one type. Defaults to ``['access', 'refresh']``.
``'refresh'`` or ``'access'``. You can pass in a sequence or a set to check
more then one type. Defaults to ``('access', 'refresh')``.
Only used if blacklisting is enabled.
================================= =========================================