swagger.yml

consumes:
- application/json
info:
  description: HTTP server in Go with Swagger endpoints definition.
  title: cloud4students
  version: 0.1.0
produces:
- application/json
schemes:
- http
securityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
    description: >-
      Enter the token with the `Bearer: ` prefix, e.g. "Bearer abcde12345".
swagger: "2.0"

paths:
  /user/signup:
    post:
      description: A user sign up
      consumes:
        - application/json
      parameters:
        - in: body
          name: user
          description: the user info to sign up.
          schema:
            $ref: '#/definitions/SingUp' 
      responses:
        201:
          description: OK
          schema:
            type: object
            properties:
              msg:
                type: string
                example: Verification Code has been sent to email@email.com
        500:
          description: Unexpected error
          schema:
            $ref: '#/responses/ErrorResponse'

  /user/signup/verify_email:
    post:
      description: Verifying sign up email
      consumes:
        - application/json
      parameters:
        - in: body
          name: code
          description: the code and email of the user to verify
          schema:
            $ref: '#/definitions/VerifyCode' 
      responses:
        201:
          description: OK
          schema:
            type: object
            properties:
              msg:
                type: string
                example: Account Created Successfully
              data:
                type: object
                properties:
                  id: 
                    type: string

        500:
          description: Unexpected error
          schema:
            $ref: '#/responses/ErrorResponse'

  /user/forget_password:
    post:
      description: A user forgets password
      consumes:
        - application/json
      parameters:
        - in: body
          name: email
          description: the email of the user to change password
          schema:
            type: object
            properties:
              email:
                type: string
      responses:
        201:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                    example: Verification Code has been sent to email@email.com
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

  /user/forget_password/verify_email:
    post:
      description: Verifying forget password email
      consumes:
        - application/json
      parameters:
        - in: body
          name: code
          description: the code and email of the user to verify
          schema:
            $ref: '#/definitions/VerifyCode' 
      responses:
        201:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                    example: Code is verified
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

  /user/signin:
    post:
      description: A user sign in
      consumes:
        - application/json
      parameters:
        - in: body
          name: user
          description: the user info to sign in.
          schema:
            $ref: '#/definitions/SingIn' 
      responses:
        201:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                    example: User signed in successfully
                  data: 
                    type: object
                    properties:
                      access_token:
                        type: string
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

  /user/refresh_token:
    post:
      description: A token to refresh
      security:
        - Bearer: []
      responses:
        201:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                    example: Token is refreshed successfully
                  data: 
                    type: object
                    properties:
                      access_token:
                        type: string
                      refresh_token:
                        type: string
        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'


  /user/change_password:
    put:
      description: A user to change their password
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: body
          name: password
          description: the user's password to update
          schema:
            $ref: '#/definitions/ChangePassword' 
      responses:
        203:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                    example: Password is changed
        404:
          $ref: '#/responses/UnfoundError'
        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

  /user/activate_voucher:
    put:
      description: A user to add voucher
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: body
          name: voucher
          description: the voucher to add
          schema:
            type: object
            properties:
              voucher:
                type: string
      responses:
        203:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                    example: Voucher is added successfully.
        401:
          $ref: '#/responses/UnauthorizedError'
        404:
          $ref: '#/responses/UnfoundError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'
  
  /user/apply_voucher:
    post:
      description: A user to apply for a voucher
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: body
          name: voucher
          description: the voucher to apply for
          schema:
            type: object
            properties:
              vms:
                type: integer
              public_ips:
                type: integer
              reason:
                type: string
      responses:
        201:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'
  
  /user:
    get:
      description: getting a user
      security:
        - Bearer: []
      consumes:
        - application/json
      responses:
        200:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      user:
                        $ref: '#/definitions/User'

        401:
          $ref: '#/responses/UnauthorizedError'
        404:
          $ref: '#/responses/UnfoundError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

    put:
      description: A user to update data
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: body
          name: data
          description: the user data to update
          schema:
            $ref: '#/definitions/UpdateData' 
      responses:
        203:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                    example: User is updated successfully
        404:
          $ref: '#/responses/UnfoundError'
        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'
  

  /quota:
    get:
      description: getting a quota
      security:
        - Bearer: []
      consumes:
        - application/json
      responses:
        200:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      quota:
                        $ref: '#/definitions/Quota'

        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
            $ref: '#/responses/ErrorResponse'

  /vm:
    post:
      description: deploy a vm
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: body
          name: vm
          description: the vm to deploy
          schema:
            $ref: '#/definitions/DeployVM'
      responses:
        201:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      id:
                        type: integer

        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

    get:
      description: get all vms for a user
      security:
        - Bearer: []
      consumes:
        - application/json
      responses:
        200:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      vm:
                        $ref: '#/definitions/Vms'

        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'
          
    delete:
      description: delete all vms for a user
      security:
        - Bearer: []
      consumes:
        - application/json
      responses:
        204:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'
  
  /vm/{id}:
    get:
      description: get a vm
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: path
          name: id
          description: vm ID
          required: true
          type: string
          format: integer
      responses:
        200:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      vm:
                        $ref: '#/definitions/Vm'

        401:
          $ref: '#/responses/UnauthorizedError'
        404:
          $ref: '#/responses/UnfoundError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

    delete:
      description: delete a vm
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: path
          name: id
          description: vm ID
          required: true
          type: string
          format: integer
      responses:
        204:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
        401:
          $ref: '#/responses/UnauthorizedError'
        404:
          $ref: '#/responses/UnfoundError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

  
  /k8s:
    post:
      description: deploy a k8s
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: body
          name: k8s
          description: the k8s to deploy
          schema:
            $ref: '#/definitions/DeployK8s'
      responses:
        201:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      id:
                        type: integer

        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

    get:
      description: get all k8s for a user
      security:
        - Bearer: []
      consumes:
        - application/json
      responses:
        200:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      k8s:
                        $ref: '#/definitions/Kubernetes_list'

        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'
  
    delete:
      description: delete all k8s for a user
      security:
        - Bearer: []
      consumes:
        - application/json
      responses:
        204:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

  /k8s/{id}:
    get:
      description: get a k8s
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: path
          name: id
          description: k8s ID
          required: true
          type: string
          format: integer
      responses:
        200:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      k8s:
                        $ref: '#/definitions/Kubernetes'

        401:
          $ref: '#/responses/UnauthorizedError'
        404:
          $ref: '#/responses/UnfoundError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

    delete:
      description: delete a k8s
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: path
          name: id
          description: k8s ID
          required: true
          type: string
          format: integer
      responses:
        204:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
        401:
          $ref: '#/responses/UnauthorizedError'
        404:
          $ref: '#/responses/UnfoundError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

  /voucher:
    get:
      description: getting all vouchers
      security:
        - Bearer: []
      consumes:
        - application/json
      responses:
        200:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      users:
                        $ref: '#/definitions/Vouchers'
        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'
    
    put:
      description: approve all vouchers
      security:
        - Bearer: []
      consumes:
        - application/json
      responses:
        203:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
        401:
          $ref: '#/responses/UnauthorizedError'
        404:
          $ref: '#/responses/UnfoundError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'
    
    post:
      description: generate a voucher
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: body
          name: voucher
          description: the voucher to generate
          schema:
            $ref: '#/definitions/GenerateVoucher'
      responses:
        201:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data: 
                    type: object
                    properties:
                      users:
                        $ref: '#/definitions/Voucher'
        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

  /voucher/{id}:
    put:
      description: approve a voucher
      security:
        - Bearer: []
      consumes:
        - application/json
      parameters:
        - in: path
          name: id
          description: voucher ID
          required: true
          type: string
          format: integer
        - in: body
          name: voucher
          description: approval status
          schema:
            type: object
            properties:
              approved:
                type: boolean
      responses:
        203:
          description: OK
          schema:
            type: object
            properties:
              msg:
                type: string
        401:
          $ref: '#/responses/UnauthorizedError'
        404:
          $ref: '#/responses/UnfoundError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

  /user/all:
    get:
      description: getting all user
      security:
        - Bearer: []
      consumes:
        - application/json
      responses:
        200:
          description: OK
          schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      users:
                        $ref: '#/definitions/Users'
        401:
          $ref: '#/responses/UnauthorizedError'
        500:
          description: Unexpected error
          schema:
                $ref: '#/responses/ErrorResponse'

definitions:  
  Users:
    type: array
    items:
      $ref: '#/definitions/UserUsedQuota'

  Vouchers:
    type: array
    items:
      $ref: '#/definitions/Voucher'

  Vms:
    type: array
    items:
      $ref: '#/definitions/Vm'
  
  Kubernetes_list:
    type: array
    items:
      $ref: '#/definitions/Kubernetes'

  User:
    type: object
    required:
      - id
    properties:
      id:
        type: string
        format: uuid
      name:
        type: string
      email:
        type: string
        format: email
      hashed_password:
        type: string
      voucher:
        type: string
      ssh_key:
        type: string
      admin:
        type: boolean
      verified: 
        type: boolean
      team_size:
        type: integer
      project_desc:
        type: string
      college:
        type: string

  UserUsedQuota:
    type: object
    properties:
      user_id:
        type: string
        format: uuid
      name:
        type: string
      email:
        type: string
        format: email
      hashed_password:
        type: string
      voucher:
        type: string
      ssh_key:
        type: string
      admin:
        type: boolean
      verified: 
        type: boolean
      team_size:
        type: integer
      project_desc:
        type: string
      college:
        type: string
      vms:
        type: integer
      public_ips:
        type: integer
      used_vms:
        type: integer
      used_public_ips:
        type: integer

  Quota:
    type: object
    required:
      - id
    properties:
      id:
        type: integer
      userID:
        type: string
        format: uuid
      vms:
        type: integer
      public_ips:
        type: integer

  Voucher:
    type: object
    required:
      - id
    properties:
      id:
        type: integer
      userID:
        type: string
        format: uuid
      voucher:
        type: string
      vms:
        type: integer
      public_ips:
        type: integer
      reason:
        type: string
      used:
        type: boolean
      approved:
        type: boolean

  Vm:
    type: object
    required:
      - id
    properties:
      id:
        type: integer
      userID:
        type: string
        format: uuid
      ygg_ip:
        type: string
      public:
        type: boolean
      public_ip:
        type: string
      cru:
        type: string
      sru:
        type: string
      mru:
        type: string
      contract_id:
        type: string
      network_contract_id:
        type: string

  Kubernetes:
    type: object
    required:
      - id
    properties:
      id:
        type: integer
      userID:
        type: string
        format: uuid
      contract_id:
        type: string
      network_contract_id:
        type: string
      master:
        type: object
        $ref: '#/definitions/Master'
      worker:
        type: array
        items:
          $ref: '#/definitions/Worker'
  
  Master:
    type: object
    properties:
      cluster_id: 
        type: integer
      name: 
        type: string
      ygg_ip:
        type: string
      public:
        type: boolean
      public_ip:
        type: string
      cru:
        type: string
      sru:
        type: string
      mru:
        type: string

  Worker:
    type: object
    properties:
      cluster_id: 
        type: integer
      name: 
        type: string
      cru:
        type: string
      sru:
        type: string
      mru:
        type: string

  SingUp:
    type: object
    required:
      - name
      - email
      - password
      - confirm_password
      - team_size
      - project_desc
      - college
    properties:
      name:
        type: string
      email:
        type: string
        format: email
      password:
        type: string
      confirm_password:
        type: string
      team_size:
        type: integer
      project_desc:
        type: string
      college:
        type: string

  VerifyCode:
    type: object
    required:
      - code
      - email
    properties:
      code:
        type: integer
      email:
        type: string
        format: email

  SingIn:
    type: object
    required:
      - password
      - email
    properties:
      email:
        type: string
        format: email
      password:
        type: string

  ChangePassword:
    type: object
    required:
      - email
      - password
      - confirm_password
    properties:
      email:
        type: string
        format: email
      password:
        type: string
      confirm_password:
        type: string

  UpdateData:
    type: object
    properties:
      name:
        type: string
      password:
        type: string
      ssh_key:
        type: string
      confirm_password:
        type: string

  DeployVM:
    type: object
    properties:
      name:
        type: string
      resources:
        type: string
        format: small-medium-large
      public:
        type: boolean
  
  DeployK8s:
    type: object
    properties:
      master_name:
        type: string
      resources:
        type: string
        format: small-medium-large
      public:
        type: boolean
      workers:
        type: array
        items:
          $ref: '#/definitions/DeployWorker'

  DeployWorker:
    type: object
    properties:
      name:
        type: string
      resources:
        type: string
        format: small-medium-large

  GenerateVoucher:
    type: object
    properties:
      length:
        type: string
      vms:
        type: integer
      public_ips:
        type: integer

responses:
  ErrorResponse:
    description: Unexpected error
    schema:
      type: object
      properties:
        err:
          type: string
  
  UnfoundError:
    description: Unfound error
    schema:
      type: object
      properties:
        err:
          type: string
          description: Object is not found

  UnauthorizedError:
    description: Unauthorized error
    schema:
      type: object
      properties:
        err:
          type: string
          description: Access token is missing or invalid