Added doc for email reset

Author: Seluj78

backend/PyMatcha/routes/api/auth/email.py

@@ -69,7 +69,7 @@ def confirm_email(token):
             u.confirmed_on = datetime.datetime.utcnow()
             u.save()
         current_app.logger.debug("/auth/confirm -> User {} confirmed.".format(u.id))
-        return Success("Confirmation successfull")
+        return Success("Confirmation successful")
 
 
 @auth_email_bp.route("/auth/confirm/new", methods=["POST"])
@@ -82,16 +82,14 @@ def request_new_email_conf():
         u = get_user(email)
     except NotFoundError:
         current_app.logger.debug("/auth/confirm/new -> User not found")
-        pass
     else:
         if u.is_confirmed:
             current_app.logger.debug("/auth/confirm/new -> User found, Already confirmed.")
-            return Success("User already confirmed")
         else:
             current_app.logger.debug("/auth/confirm/new -> User found, sending new confirmation email")
             token = generate_confirmation_token(email=email, token_type="confirm")
             link = FRONTEND_EMAIL_CONFIRMATION_URL + token
             rendered_html = render_template("confirm_email.html", link=link)
             send_mail_html.delay(dest=data["email"], subject="Confirm your email on PyMatcha", html=rendered_html)
     current_app.logger.debug("/auth/confirm/new -> New confirmation email sent if user exists in database")
-    return Success("New confirmation email sent if user exists in database")
+    return Success("New confirmation email sent if user exists in database and isn't already confirmed")

backend/schemas/swagger.yaml

@@ -241,6 +241,82 @@ paths:
                   message:
                     type: string
                     example: Refresh token revoked
+  /auth/confirm/{token}:
+    post:
+      summary: Confirm a user with a token
+      operationId: confirmUser
+      tags:
+        - Authentication
+      parameters:
+        - name: token
+          in: path
+          required: true
+          description: The confirmation token
+          schema:
+            type: string
+      responses:
+        "404":
+          $ref: '#/components/responses/NotFound'
+        "400":
+          $ref: '#/components/responses/BadRequest'
+        "200":
+          description: Returned user to view
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    description: If the request is a success
+                    example: true
+                  code:
+                    type: integer
+                    description: The status code
+                    example: 200
+                  message:
+                    type: string
+                    example: Confirmation successful
+  /auth/confirm/new:
+    post:
+      summary: Request a new confirmation email
+      description: Will always return a success, even if the user is not found or already confirmed
+      operationId: newConfirmEmail
+      tags:
+        - Authentication
+      requestBody:
+        description: Parameters to request new confirmation email
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                email:
+                  required: true
+                  type: string
+                  example: foo@example.org
+      responses:
+        "400":
+          $ref: '#/components/responses/BadRequest'
+        "200":
+          description: Returned user to view
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    description: If the request is a success
+                    example: true
+                  code:
+                    type: integer
+                    description: The status code
+                    example: 200
+                  message:
+                    type: string
+                    example: New confirmation email sent if user exists in database and isn't already confirmed
   /profile/complete:
     post:
       tags: