Island: Add docstrings to Authenticate resource

This commit is contained in:
Shreya Malviya 2022-08-02 14:42:58 +05:30
parent 677e2755b9
commit 9f02fd4e44
1 changed files with 6 additions and 9 deletions

View File

@ -22,10 +22,7 @@ def init_jwt(app):
class Authenticate(AbstractResource):
"""
Resource for user authentication. The user provides the username and password and we \
give them a JWT. \
See `AuthService.js` file for the frontend counterpart for this code. \
A resource for user authentication
"""
urls = ["/api/authenticate"]
@ -35,13 +32,13 @@ class Authenticate(AbstractResource):
def post(self):
"""
Example request: \
{ \
"username": "my_user", \
"password": "my_password" \
} \
Gets a username and password from the request sent from the client, authenticates, and
returns an access token
:return: Access token in the response body
:raises IncorrectCredentialsError: If credentials are invalid
"""
username, password = get_username_password_from_request(request)
try: