Skip to content
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.

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

Complete jwt documentation #654

Merged
merged 3 commits into from
Apr 29, 2021

Conversation

johachi
Copy link
Contributor

@johachi johachi commented Apr 29, 2021

Description

  • Added documentation for jwt.decode_complete.
    I'm honestly unsure if everything needs to be duplicated or not since the only thing that is different to jwt.decode is the return value. I'm happy to just write Parameters: Sames as jwt.decode if that is preferred.

  • I previously wrote (e.g.) verify_aud=True`` but will be ignored if ``verify_signature`` is ``False``. for all the options parameters except require and verify_signature, but that is a bad way of describing it.

    What I wanted to write was that the value is True by default, but will default to False if verify_signature is set to false. In other words, they default to the same value as verify_signature. I, therefore, think that a better way of writing this is verify_aud=verify_signature, and then move verify_signature=True to the top. This way, it is understandable that it is possible to set (e.g.) verify_aud=True and verify_signature=False.

  • Added a warning regarding exp, iat and nbf only being verified if present.

Screenshot (Firefox Developers Edition 89.0b5)
Documentation

@jpadilla jpadilla added the docs label Apr 29, 2021
Copy link
Owner

@jpadilla jpadilla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✨ thanks!

@jpadilla jpadilla merged commit 45fc348 into jpadilla:master Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants