APIs

openapi: 3.0.2
info:
  title: APIs
  version: 1.0.0
servers:
  - url: 'http://localhost:8080'
    description: localhost
paths:
  '/account/activate':
    get:
      summary: >
        - feature: 
        - api: no
        - authenticated: no
      description: >
        activate an account.
      parameters:
        - name: uuid
          in: query
          description: User's uuid.
          required: true
          schema:
            type: string
        - name: key
          in: query
          description: The activation key.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >
            return a view
  '/account/reset-password':
    get:
      summary: >
        - feature: 
        - api: no
        - authenticated: no
      description: >
        reset password of an account.
      parameters:
        - name: uuid
          in: query
          description: User's uuid.
          required: true
          schema:
            type: string
        - name: token
          in: query
          description: The forgot password token generated by ezylogin.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >
            return a view
  '/logout':
    post:
      summary: >
        - feature: 
        - api: no
        - authenticated: no
      description: >
        logout an user by remove access token cookie.
      responses:
        '302':
          description: >
            redirect
  '/ezylogin/api/v1/{providerName}/oauth20-url':
    get:
      summary: >
        - feature: 
        - api: no
        - authenticated: yes
      description: >
        profile oauth20 login url.
      parameters:
        - name: providerName
          in: path
          description: parameter
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >
            success
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
  '/ezylogin/api/v1/reset-password':
    post:
      summary: >
        - feature: 
        - api: no
        - authenticated: yes
      description: >
        reset password of an user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                forgotPasswordToken:
                  type: string
                newPassword:
                  type: string
                userUuid:
                  type: string
      responses:
        '204':
          description: >
            no content
  '/ezylogin/api/v1/forgot-password':
    post:
      summary: >
        - feature: 
        - api: no
        - authenticated: yes
      description: >
        Send a forgot password email to an user.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
      responses:
        '204':
          description: >
            no content
  '/ezylogin/api/v1/resend-activation-email':
    post:
      summary: >
        - feature: 
        - api: no
        - authenticated: yes
      description: >
        Resend an activation email to an user.
      responses:
        '204':
          description: >
            no content
  '/ezylogin/api/v1/login':
    post:
      summary: >
        - feature: 
        - api: no
        - authenticated: yes
      description: >
        Handle user login request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                password:
                  type: string
                username:
                  type: string
      responses:
        '200':
          description: >
            success
          content:
            application/json:
              schema:
                type: object
                properties:
                  accessToken:
                    type: string
                  accessTokenExpiredAt:
                    type: integer
                  accessTokenStatus:
                    type: string
  '/ezylogin/api/v1/register':
    post:
      summary: >
        - feature: 
        - api: no
        - authenticated: yes
      description: >
        Handle user register request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                displayName:
                  type: string
                email:
                  type: string
                password:
                  type: string
                phoneNumber:
                  type: string
                username:
                  type: string
      responses:
        '200':
          description: >
            success
          content:
            application/json:
              schema:
                type: object
                properties:
                  accessToken:
                    type: string
                  accessTokenExpiredAt:
                    type: integer
                  accessTokenStatus:
                    type: string
  '/ezylogin/callback/{providerName}':
    get:
      summary: >
        - feature: 
        - api: no
        - authenticated: no
      description: >
        Oauth20 call back url.
      parameters:
        - name: providerName
          in: path
          description: parameter
          required: true
          schema:
            type: string
        - name: code
          in: query
          description: default value is null
          required: true
          schema:
            type: string
      responses:
        '302':
          description: >
            redirect