Add docs for flask signals

lepture · Sep 2, 2019 · e970f87 · e970f87
1 parent 55a9de4
commit e970f87
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/authlib/django/oauth2/__init__.py b/authlib/django/oauth2/__init__.py
@@ -1,4 +1,8 @@
 from .authorization_server import AuthorizationServer
 from .resource_protector import ResourceProtector, BearerTokenValidator
 from .endpoints import RevocationEndpoint
-from .signals import *
+from .signals import (
+    client_authenticated,
+    token_authenticated,
+    token_revoked
+)
diff --git a/authlib/flask/oauth2/signals.py b/authlib/flask/oauth2/signals.py
@@ -2,6 +2,11 @@
 
 _signal = Namespace()
 
+#: signal when client is authenticated
 client_authenticated = _signal.signal('client_authenticated')
-token_authenticated = _signal.signal('token_authenticated')
+
+#: signal when token is revoked
 token_revoked = _signal.signal('token_revoked')
+
+#: signal when token is authenticated
+token_authenticated = _signal.signal('token_authenticated')
diff --git a/docs/flask/2/api.rst b/docs/flask/2/api.rst
@@ -34,6 +34,18 @@ Server.
             # current token instance of the OAuth Token model
             return current_token.user_id
 
+.. data:: client_authenticated
+
+    Signal when client is authenticated
+
+.. data:: token_revoked
+
+    Signal when token is revoked
+
+.. data:: token_authenticated
+
+    Signal when token is authenticated
+
 Cache Helper Functions
 ----------------------