gitlab-acebase/src/routes/auth-forgot-password.yaml

AceBase realtime database server (webserver endpoint to allow remote connections)

/auth/{dbname}/forgot_password:
  post:
    tags:
      - auth
    summary: Issue a password reset
    description: Issues a password reset for a user that forgot their password. User must have an email address in the database.
    parameters:
      - name: dbname
        in: path
        description: name of the database
        required: true
        schema:
          type: string
          example: mydb
    requestBody:
      description: user details
      content:
        'application/json':
          schema:
            type: object
            properties:
              email:
                type: string
                description: User's email address. A password reset email will be sent to this address
            required:
              - email
    responses:
      200:
        description: If a password reset email has been successfully sent, returns the string `"OK"`
        content:
          'text/plain':
            schema:
              type: 'string'
              value: OK
              description: The string `"OK"`
      400:
        description: Returns a `"400 Bad Request"` if the server has not been configured properly, or if no or invalid email address was sent with the request
        content:
          'application/json':
            schema:
              $ref: '#/components/schemas/Error'
              example:
                code: invalid_email
                message: Email address not found, or duplicate entries found
      500:
        description: An unexpected error occurred
        content:
          'application/json':
            schema:
              $ref: '#/components/schemas/UnexpectedError'