Document password reset route

This commit is contained in:
Tanner Collin 2020-06-20 00:35:58 +00:00
parent 41e1359516
commit 1e685187df
2 changed files with 37 additions and 0 deletions

View File

@ -191,6 +191,41 @@ Change Password
{"detail":"New password has been saved."}
Reset Password
++++++++++++++
.. http:post:: /rest-auth/password/reset/
:json email:
**Example response**:
.. sourcecode:: json
{"detail":"Password reset e-mail has been sent."}
Confirm Reset
+++++++++++++
.. http:post:: /rest-auth/password/reset/confirm/
The uid and token are found in the email sent:
``/password-reset/confirm/{uid}/{token}/``
:json uid:
:json token:
:json new_password1:
:json new_password2:
**Example response**:
.. sourcecode:: json
{"detail":"Password has been reset with the new password."}
Members
-------

View File

@ -40,6 +40,8 @@ Quick Reference
.. http:post:: /rest-auth/login/
.. http:get:: /user/
.. http:post:: /password/change/
.. http:post:: /rest-auth/password/reset/
.. http:post:: /rest-auth/password/reset/confirm/
.. http:get:: /members/(id)/
.. http:post:: /members/
.. http:patch:: /members/(id)/