summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJon Dufresne <jon.dufresne@gmail.com>2020-12-16 17:29:12 -0800
committerGitHub <noreply@github.com>2020-12-16 20:29:12 -0500
commit3f65aa413530157b8b09c4c933de4f8a97a639c1 (patch)
tree33d4d4843ae207b63a2db525f67d51b8de5b89cf /docs
parent6ce4e35a9d373bb969235d99bdb42965e7bba38a (diff)
downloadpyjwt-3f65aa413530157b8b09c4c933de4f8a97a639c1.tar.gz
Remove deprecated arguments from docs (#544)
They were removed from the code in f690976596bb74221f5a81fc9afffd5609bc4e70.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst16
-rw-r--r--docs/usage.rst6
2 files changed, 4 insertions, 18 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 6ca0b62..eb95f4c 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -19,16 +19,12 @@ API Reference
:rtype: str
:returns: a JSON Web Token
-.. function:: decode(jwt, key="", verify=True, algorithms=None, options=None, audience=None, issuer=None, leeway=0, verify_expiration=True)
+.. function:: decode(jwt, key="", algorithms=None, options=None, audience=None, issuer=None, leeway=0)
Verify the ``jwt`` token signature and return the token claims.
:param str|bytes jwt: the token to be decoded
:param str key: the key suitable for the allowed algorithm
- :param bool verify: whether to verify the JWT signature, on by default
-
- .. deprecated:: 1.5.1
- to disable signature validation, use ``options=(verify_signature=False)``
:param list algorithms: allowed algorithms, e.g. ``["ES256"]``
@@ -46,20 +42,10 @@ API Reference
* ``verify_exp=False`` check that ``exp`` (expiration) claim value is OK
* ``verify_iss=False`` check that ``iss`` (issuer) claim matches ``issuer``
* ``verify_signature=True`` verify the JWT cryptographic signature
- * ``verify_expiration``
-
- .. deprecated:: 1.2.0
- Use ``verify_exp`` instead
-
:param iterable audience: optional, the value for ``verify_aud`` check
:param str issuer: optional, the value for ``verify_iss`` check
:param int|float leeway: a time margin in seconds for the expiration check
- :param bool verify_expiration:
-
- .. deprecated:: 1.2.0
- Use ``options=(verify_exp=...)`` instead
-
:rtype: dict
:returns: the JWT claims
diff --git a/docs/usage.rst b/docs/usage.rst
index 9264b22..ced7bfe 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -54,8 +54,8 @@ Reading the Claimset without Validation
---------------------------------------
If you wish to read the claimset of a JWT without performing validation of the
-signature or any of the registered claim names, you can set the ``verify``
-parameter to ``False``.
+signature or any of the registered claim names, you can set the
+``verify_signature`` option to ``False``.
Note: It is generally ill-advised to use this functionality unless you
clearly understand what you are doing. Without digital signature information,
@@ -63,7 +63,7 @@ the integrity or authenticity of the claimset cannot be trusted.
.. code-block:: python
- >>jwt.decode(encoded, verify=False)
+ >>jwt.decode(encoded, options={"verify_signature": False})
{u'some': u'payload'}
Reading Headers without Validation