From 7bfb6a45ac682954f2f4646b2c2054de86162a6f Mon Sep 17 00:00:00 2001 From: Dominik George <dominik.george@teckids.org> Date: Fri, 5 Nov 2021 19:17:30 +0100 Subject: [PATCH] Fix docstrings for linter --- aleksis/core/util/auth_helpers.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/aleksis/core/util/auth_helpers.py b/aleksis/core/util/auth_helpers.py index 2e89917a6..21acddda5 100644 --- a/aleksis/core/util/auth_helpers.py +++ b/aleksis/core/util/auth_helpers.py @@ -133,6 +133,7 @@ class AppScopes(BaseScopes): class ClientProtectedResourceMixin(_ClientProtectedResourceMixin): """Mixin for protecting resources with client authentication as mentioned in rfc:`3.2.1`. + This involves authenticating with any of: HTTP Basic Auth, Client Credentials and Access token in that order. Breaks off after first validation. @@ -143,7 +144,7 @@ class ClientProtectedResourceMixin(_ClientProtectedResourceMixin): """ def authenticate_client(self, request: HttpRequest) -> bool: - """Returns a boolean representing if client is authenticated with client credentials. + """Return a boolean representing if client is authenticated with client credentials. If the view has configured required scopes, they are verified against the application's allowed scopes. -- GitLab