socket.yml

name: user-auth
description: Basic user auth/register Socket
runtime: nodejs_v8
version: 1.1.2

keywords:
  - user
  - register
  - auth
  - authentication

classes:
  user:
    - name: email
      type: string
    - name: fullName
      type: string

endpoints:
  login:
    description: Log in user by checking username and password
    inputs:
      required:
        - username
        - password
      properties:
        username:
          type: string
          minLength: 2
        password:
          type: string
          minLength: 2
    response:
      success:
        exit_code: 200
        description: Success
        example: |
          {
            "token": "cb21ff98ac8c7dda8fcd0129b0adb0254dea5c8e",
            "username": "username"
          }
      fail:
        exit_code: 400
        description: Authentication failed
        example: |
          {
             "message": "Given credentials are invalid."
          }
  register:
    description: Register user
    inputs:
      required:
        - username
        - password
      properties:
        fullName:
          type: string
          minLength: 2
        username:
          type: string
          minLength: 2
        password:
          type: string
          minLength: 6
    response:
      success:
        description: Success
        example: |
          {
            "token": "cb21ff98ac8c7dda8fcd0129b0adb0254dea5c8e",
            "username": "username"
          }
      wrongEmail:
        exit_code: 400
        description: Username is not a valid email
        example: |
          {
             "username": "Given email is invalid." }
          }
      userAlreadyExist:
        exit_code: 400
        description: Failed
        example: |
          {
             "username": "User already exists." }
          }
  social-login:
    inputs:
      required:
        - accessToken
      properties:
        accessToken:
          type: string
          minLength: 2
    response:
      success:
        description: Success
        example: |
          {
            "token": "cb21ff98ac8c7dda8fcd0129b0adb0254dea5c8e",
            "username": "username"
          }
      fail:
        exit_code: 400
        description: Authentication failed
        example: |
          {
             "message": "Error!"
          }