swagger.yml

consumes:
- application/json
info:
  title: Yet another expense splitter
  version: 1.0.0
paths: {}
produces:
- application/json
schemes:
- http
swagger: "2.0"

paths:
  /login:
    post:
      summary: Creates a new session - login
      operationId: createSession
      tags:
        - session
      parameters:
        - name: credentials
          in: body
          description: User credentials
          required: true
          schema:
            $ref: '#/definitions/credentials'
      responses:
        200:
          description: login
          schema:
            $ref: "#/definitions/jwtToken"
        401:
          $ref: "#/definitions/401"

  /users:
    post:
      summary: Create user - signup
      operationId: createUser
      tags:
        - users
      parameters:
        - name: user
          in: body
          description: User to be created
          required: true
          schema:
            $ref: '#/definitions/newUser'
      responses:
        200:
          description: create user - signup
          schema:
            $ref: "#/definitions/user"
        422:
          $ref: "#/definitions/422"

    get:
      summary: List other users
      operationId: listUsers
      tags:
        - users
      parameters:
        - $ref: "#/definitions/authorizationHeader"
      responses:
        200:
          description: list the other users
          schema:
            $ref: "#/definitions/users"
        401:
          $ref: "#/definitions/401"

  /expenses:
    get:
      summary: List of all expenses owed to logged in user
      operationId: getExpenses
      tags:
        - expenses
      parameters:
        - $ref: "#/definitions/authorizationHeader"
      responses:
        200:
          description: list expenses
          schema:
            $ref: "#/definitions/expenses"
        401:
          $ref: "#/definitions/401"

    post:
      summary: Create a new expense
      operationId: createExpense
      tags:
        - expenses
      parameters:
        - $ref: "#/definitions/authorizationHeader"
        - name: expense
          in: body
          description: Expense fields
          required: true
          schema:
            $ref: '#/definitions/newExpense'
      responses:
        200:
          schema:
            $ref: "#/definitions/expense"
        401:
          $ref: "#/definitions/401"
        422:
          $ref: "#/definitions/422"

  /payables:
    get:
      summary: List of all payables owed by logged in user
      operationId: getPayables
      tags:
        - payables
      parameters:
        - $ref: "#/definitions/authorizationHeader"
      responses:
        200:
          description: list payables
          schema:
            $ref: "#/definitions/payables"
        401:
          $ref: "#/definitions/401"

  /payables/{payableID}:
    put:
      summary: Updates the given payable
      operationId: updatePayableById
      tags:
        - payables
      parameters:
        - $ref: "#/definitions/authorizationHeader"
        - name: payableID
          in: path
          description: ID of payable to update
          required: true
          type: integer
          format: uint
        - name: payable
          in: body
          description: Payable fields to update
          required: true
          schema:
            $ref: '#/definitions/newPayable'
      responses:
        200:
          schema:
            $ref: "#/definitions/payable"
        401:
          $ref: "#/definitions/401"
        422:
          $ref: "#/definitions/422"

definitions:
  credentials:
    type: object
    properties:
      Username:
        type: string
      Password:
        type: string

  jwtToken:
    type: object
    properties:
      token:
        type: string
        readOnly: true

  authorizationHeader:
    name: Authorization
    in: header
    description: JWT Auth Token as - "Bearer {jwtToken}"
    schema:
      type: string
      pattern: Bearer \w+.\w+.\w+

  user:
    allOf:
      - $ref: "#/definitions/newUserWithoutPassword"
    required:
      - ID
    properties:
      ID:
        type: integer
        readOnly: true
      CreatedAt:
        type: dateTime
      UpdatedAt:
        type: dateTime
      DeletedAt:
        type: dateTime

  newUserWithoutPassword:
    type: object
    required:
      - Username
      - FirstName
      - LastName
      - MobileNumber
    properties:
      Username:
        type: string
      FirstName:
        type: string
      LastName:
        type: string
      MobileNumber:
        type: string

  newUser:
    allOf:
      - $ref: "#/definitions/newUserWithoutPassword"
    required:
      - Password
    properties:
      Password:
        type: string

  users:
    type: array
    items:
      $ref: '#/definitions/user'

  expense:
    type: object
    allOf:
      - $ref: "#/definitions/newExpenseWithoutPayables"
    required:
      - ID
    properties:
      ID:
        type: integer
        format: uint
      CreatedBy:
        type: integer
        format: uint
      CreatedAt:
        type: dateTime
      UpdatedAt:
        type: dateTime
      DeletedAt:
        type: dateTime
      Payables:
        $ref: "#/definitions/payables"

  newExpenseWithoutPayables:
    type: object
    properties:
      Amount:
        type: number
        format: float64
      Place:
        type: string

  newExpense:
    type: object
    allOf:
      - $ref: "#/definitions/newExpenseWithoutPayables"
    required:
      - Amount
      - Place
    properties:
      Payables:
        $ref: "#/definitions/newPayables"

  expenses:
    type: array
    items:
      $ref: '#/definitions/expense'

  payable:
    type: object
    allOf:
      - $ref: "#/definitions/newPayable"
    required:
      - ID
    properties:
      ID:
        type: integer
        format: uint
      CreatedAt:
        type: dateTime
      UpdatedAt:
        type: dateTime
      DeletedAt:
        type: dateTime
      ExpenseID:
        type: integer
        format: uint

  newPayable:
    type: object
    required:
      - UserID
      - Status
      - AmountOwed
      - RatioInPercentage
    properties:
      UserID:
        type: integer
        format: uint
      RatioInPercentage:
        type: number
        format: float64
      AmountOwed:
        type: number
        format: float64
      Status:
        type: string

  newPayables:
    type: array
    items:
      $ref: '#/definitions/newPayable'

  payables:
    type: array
    items:
      $ref: '#/definitions/payable'

  401:
    description: unauthorized
    schema:
      type: string

  422:
    description: Unprocessable entity
    schema:
      type: string