summaryrefslogtreecommitdiff
path: root/docs/usage.rst
Commit message (Collapse)AuthorAgeFilesLines
* Require tweak (#280)Pau Ruiz Safont2020-05-141-0/+10
| | | | | | | | | | | * Use require options as a list, instead of booleans Deprecate the use of the boolean options * Add test for the new require option * Add documentation on how to use the require option Co-authored-by: Pau Ruiz i Safont <psafont@ebi.ac.uk>
* Document top-level .encode and .decode to close #459 (#482)Dima Tisnek2020-04-261-3/+3
| | | Co-authored-by: José Padilla <jpadilla@webapplicate.com>
* Improve documentation for audience usage (#484)Correy Lim2020-04-261-8/+35
| | | | | | | | | | | | | | | | | | | | | | | * Add code example for `aud` being an array The previous code example only showed the `aud` claim as a single case-sensitive string, despite the documentation mentioning that the `aud` claim can be an array of case-sensitive strings Add a code block demonstrating the `aud` claim being an array of case-sensitive strings to make it more clear to the user that it is a permitted use of the `aud` claim * Add example of the `audience` param as an iterable Demonstrate to users reading the documentation that the `audience` parameter is not restricted to the `string` type, but can also accept an iterable, as implemented in PR#306 https://github.com/jpadilla/pyjwt/pull/306 * Fix short title underlines Short title underlines throw warnings in reStructuredText linters
* Update usage.rst (#360)PatrikBillgren2018-07-191-1/+1
| | | Small typo fix
* Added section to usage docs for jwt.get_unverified_header() (#350)Alejandro J. C De Baca2018-05-191-0/+14
|
* Add missing close quote. (#327)Stephen Paulger2018-01-231-1/+1
|
* docs: Add example of encoding and decoding tokens with RSA (#313)Mark Adams2017-11-281-2/+17
| | | | | | | | | | * docs: Add example of encoding and decoding tokens with RSA Some users have complained that the docs don't make it very clear that the private key / public key need to be a byte string. This change makes that clearer by adding an example to usage.rst. * flake8: Fix a couple of linting errors due to a new version of flake8-import-order
* Add 'algorithms=[]' kwargs to jwt.decode() examplesLandon GB2017-07-281-5/+5
| | | | Added because of this commit: 11f30c4050a11b6398d38f505578c9dabeba6c78
* Non-numeric 'iat' now raises InvalidIssuedAtError on decode()190-remove-iat-verificationMark Adams2017-04-171-0/+2
|
* Stop rejecting tokens with future 'iat' valuesMark Adams2017-04-171-3/+0
| | | | | | | | | | RFC 7519 does not specify or even suggest this type of validation on the 'iat' claim and it has caused issues for several consumers of PyJWT. This change removes the validation on future 'iat' values and leaves such things up to the application developer to implement. Fixes #190.
* Added docs/ with awesome new documentation 🎉Mark Adams2015-10-231-0/+189
View Lorry Controller Status