mirror of
				https://github.com/Tivix/django-rest-auth.git
				synced 2025-10-31 07:47:33 +03:00 
			
		
		
		
	Update API endpoints docs and docstring
https://github.com/Tivix/django-rest-auth/issues/280
This commit is contained in:
		
							parent
							
								
									6812deeeb4
								
							
						
					
					
						commit
						f79537de77
					
				|  | @ -6,14 +6,13 @@ Basic | |||
| 
 | ||||
| - /rest-auth/login/ (POST) | ||||
| 
 | ||||
|     - username (string) | ||||
|     - email (string) | ||||
|     - password (string) | ||||
|     - username | ||||
|     - email | ||||
|     - password | ||||
| 
 | ||||
|     Returns Token Object's key | ||||
| 
 | ||||
| - /rest-auth/logout/ (POST, GET) | ||||
| 
 | ||||
|     - token | ||||
| - /rest-auth/logout/ (POST) | ||||
| 
 | ||||
|     .. note:: ``ACCOUNT_LOGOUT_ON_GET = True`` to allow logout using GET - this is the exact same configuration from allauth. NOT recommended, see: http://django-allauth.readthedocs.io/en/latest/views.html#logout | ||||
| 
 | ||||
|  | @ -35,20 +34,17 @@ Basic | |||
|     - new_password1 | ||||
|     - new_password2 | ||||
|     - old_password | ||||
|     - token | ||||
| 
 | ||||
|     .. note:: ``OLD_PASSWORD_FIELD_ENABLED = True`` to use old_password. | ||||
|     .. note:: ``LOGOUT_ON_PASSWORD_CHANGE = False`` to keep the user logged in after password change | ||||
| 
 | ||||
| - /rest-auth/user/ (GET) | ||||
| 
 | ||||
| - /rest-auth/user/ (PUT/PATCH) | ||||
| - /rest-auth/user/ (GET, PUT, PATCH) | ||||
| 
 | ||||
|     - username | ||||
|     - first_name | ||||
|     - last_name | ||||
|     - email | ||||
|     - token | ||||
| 
 | ||||
|     Returns pk, username, email, first_name, last_name | ||||
| 
 | ||||
| 
 | ||||
| Registration | ||||
|  |  | |||
|  | @ -158,10 +158,11 @@ class PasswordResetView(GenericAPIView): | |||
| 
 | ||||
| class PasswordResetConfirmView(GenericAPIView): | ||||
|     """ | ||||
|     Password reset e-mail link is confirmed, therefore this resets the user's password. | ||||
|     Password reset e-mail link is confirmed, therefore | ||||
|     this resets the user's password. | ||||
| 
 | ||||
|     Accepts the following POST parameters: new_password1, new_password2 | ||||
|     Accepts the following Django URL arguments: token, uid | ||||
|     Accepts the following POST parameters: token, uid, | ||||
|         new_password1, new_password2 | ||||
|     Returns the success/fail message. | ||||
|     """ | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
		Reference in New Issue
	
	Block a user