swagger.json

{
  "swagger": "2.0",
  "info": {
    "version": "1",
    "title": "Banka API Endpoints Documentation"
  },
  "host": "bankaapi.herokuapp.com",
  "basePath": "/api/v1",
  "jwtsecurity": {
    "type": "apiKey",
    "name": "Authorization",
    "in": "header"
  },

  "schemes": ["http"],

  "consumes": ["application/json"],
  "produces": ["application/json"],
  "definitions": {
    "signup": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      }
    },
    "signin": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      }
    },
    "usertype": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "isAdmin": {
          "type": "string"
        },
        "email": {
          "type": "string"
        }
      }
    },
    "account": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        }
      }
    },
    "account_status": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        }
      }
    },
    "transaction": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "number"
        }
      }
    }
  },
  "paths": {
    "/auth/signup": {
      "post": {
        "tags": ["Sign up"],
        "description": "Create new user acount",
        "parameters": [
          {
            "name": "user",
            "in": "body",
            "description": "For the new users to sign up",
            "schema": {
              "$ref": "#/definitions/signup"
            }
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "201": {
            "description": "Welcome to Banka, Your user account has been created",
            "schema": {
              "$ref": "#/definitions/signup"
            }
          },
          "400": {
            "description": "Specific error message for (400)"
          },
          "409": {
            "description": "Email already exists, please try another"
          }
        }
      }
    },
    "/auth/login": {
      "post": {
        "tags": ["LOGIN"],
        "description": "User Log in",
        "parameters": [
          {
            "name": "user",
            "in": "body",
            "description": "The login is for the people who already has an account to banka",
            "schema": {
              "$ref": "#/definitions/signin"
            }
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "You have successfully log in Banka",
            "schema": {
              "$ref": "#/definitions/signin"
            }
          },
          "400": {
            "description": "Email, Password and type are required !"
          },
          "401": {
            "description": "Wrong email or password"
          }
        }
      }
    },
    "/transactions/{accountNumber}/credit": {
      "post": {
        "tags": ["Transactions"],
        "description": "Credit a Bank Acoount",
        "parameters": [
          {
            "name": "accountNumber",
            "in": "path",
            "description": "The account number to credit",
            "required": true
          },

          {
            "name": "Authorization",
            "in": "header",
            "description": "The cashier token",
            "required": true
          },
          {
            "name": "Amount",
            "in": "body",
            "description": "The amount of money to credit",
            "schema": {
              "$ref": "#/definitions/transaction"
            }
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "201": {
            "description": "Transaction sucessful",
            "schema": {
              "$ref": "#/definitions/transaction"
            }
          },
          "404": {
            "description": "The account you are trying to debit from do not exists"
          },
          "400": {
            "description": "Missing amount or invalid amount format"
          },
          "401": {
            "description": "Token expired please login again"
          }
        }
      }
    },

    "/accounts/{accountNumber}/transactions": {
      "get": {
        "tags": ["Accounts"],
        "description": "View account transactions history",
        "parameters": [
          {
            "name": "accountNumber",
            "in": "path",
            "description": "Transactions",
            "required": true,
            "type": "integer"
          },

          {
            "name": "Authorization",
            "in": "header",
            "description": "Token",
            "required": true
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {},
          "404": {
            "description": "User does not own any account with the provided number"
          },
          "401": {
            "description": "Token expired please login again"
          }
        }
      }
    },
    "/category?status=active": {
      "get": {
        "tags": ["Accounts"],
        "description": "View all active/dormant/draft Bank accounts",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "description": "Token",
            "required": true
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "Token",
            "required": true
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "All active/dormant/draft Bank accounts"
          },
          "400": {
            "description": "Invalid or missing account status"
          },
          "401": {
            "description": "Token expired please login again"
          }
        }
      }
    },
    "/accounts/{account-number}": {
      "get": {
        "tags": ["Accounts"],
        "description": "View a specific account’s details",
        "parameters": [
          {
            "name": "accountNumber",
            "in": "path",
            "description": "View a specific account’s details",
            "required": true
          },

          {
            "name": "Authorization",
            "in": "header",
            "description": "Token",
            "required": true
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Account detail response"
          },
          "401": {
            "description": "Token expired please login again"
          },
          "404": {
            "description": "User does not own any account with the provided accountNumber"
          }
        }
      }
    },
    "/user/{email}/accounts": {
      "get": {
        "tags": ["Accounts"],
        "description": "View all accounts owned by a specific user",
        "parameters": [
          {
            "name": "email",
            "in": "path",
            "description": "The email address of the client",
            "required": true
          },

          {
            "name": "Authorization",
            "in": "header",
            "description": "The admin token",
            "required": true
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "All user's Bank accounts"
          },
          "401": {
            "description": "Token expired please login again"
          }
        }
      }
    },
    "/accounts": {
      "get": {
        "tags": ["Accounts"],
        "description": "View all Bank accounts by admin/staff",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "The admin token",
            "required": true
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "{success}The list of all Bank accounts"
          }
        }
      },
      "post": {
        "tags": ["Accounts"],
        "description": "Create Bank account",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Token",
            "required": true
          },
          {
            "name": "account type",
            "in": "body",
            "description": "Valid Bank Account type is current, savings or loan",
            "schema": {
              "$ref": "#/definitions/account"
            }
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "201": {
            "description": "You have successfully created Bank account",
            "schema": {
              "$ref": "#/definitions/account"
            }
          },
          "401": {
            "description": "Token expired please login again"
          },
          "400": {
            "description:": "Thre are many responses with 400 status code"
          }
        }
      }
    },
    "/user/accounts": {
      "get": {
        "tags": ["Accounts"],
        "description": "View all accounts belonging to the current user",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "The user token",
            "required": true
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "List of all current user bank accounts"
          },
          "401": {
            "description": "Token expired please login again"
          }
        }
      }
    },
    "/account/{accountNumber}": {
      "patch": {
        "tags": ["Accounts"],
        "description": "Activate or deactivate a Bank account",
        "parameters": [
          {
            "name": "accountNumber",
            "in": "path",
            "description": "account Number",
            "required": true
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "Cashier token",
            "required": true
          },

          {
            "name": "account status",
            "in": "body",
            "description": "Bank Account status should be active / dormant or draft",
            "schema": {
              "$ref": "#/definitions/account_status"
            }
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "The account has been updated",
            "schema": {
              "$ref": "#/definitions/account_status"
            }
          },
          "401": {
            "description": "Token expired please login again"
          },
          "403": {
            "description": "User does not have the rights to perform the operation"
          },
          "400": {
            "description": "Status is required || Status should be active, dormant or draft"
          }
        }
      },
      "delete": {
        "tags": ["Accounts"],
        "description": "Delete a bank account by admin",
        "parameters": [
          {
            "name": "accountnumber",
            "in": "path",
            "description": "The account number to delete",
            "required": true
          },

          {
            "name": "Authorization",
            "in": "header",
            "description": "Token",
            "required": true
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Bank account has been deleted successfully"
          },
          "404": {
            "description": "The account you are trying to delete does not exists"
          },
          "401": {
            "description": "Token expired please login again"
          }
        }
      }
    },
    "/transactions/{accountNumber}/debit": {
      "post": {
        "tags": ["Transactions"],
        "description": "Debit a Bank Acoount",
        "parameters": [
          {
            "name": "accountNumber",
            "in": "path",
            "description": "The account number to debit",
            "required": true
          },

          {
            "name": "Authorization",
            "in": "header",
            "description": "The cashier token",
            "required": true
          },
          {
            "name": "Amount",
            "in": "body",
            "description": "The amount of money to debit",
            "schema": {
              "$ref": "#/definitions/transaction"
            }
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "201": {
            "description": "Transaction sucessful",
            "schema": {
              "$ref": "#/definitions/transaction"
            }
          },
          "404": {
            "description": "The account you are trying to debit from do not exists"
          },
          "400": {
            "description": "Missing amount or invalid amount format"
          },
          "401": {
            "description": "Token expired please login again"
          }
        }
      }
    },
    "/transactions/{transactionId}": {
      "get": {
        "tags": ["Transactions"],
        "description": "View a specific transaction",
        "parameters": [
          {
            "name": "transactionId",
            "in": "path",
            "description": "The transaction id to view",
            "required": true
          },

          {
            "name": "Authorization",
            "in": "header",
            "description": "The client token",
            "required": true
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Transaction details"
          },
          "404": {
            "description": "Transacction with transacionId does not exist"
          },
          "401": {
            "description": "Token expired please login again"
          }
        }
      }
    },
    "/users": {
      "get": {
        "tags": ["Users"],
        "description": "View all user accounts by the admin. These are not bank accounts",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "The admin token",
            "required": true
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "{success}The list of all user accounts...not bank accounts"
          },
          "401": {
            "description": "Failed to authenticate token"
          }
        }
      },
      "put": {
        "tags": ["Users"],
        "description": "Change user type [staff/admin/client] by admin",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Admin token",
            "required": true
          },

          {
            "name": "Change user type",
            "in": "body",
            "description": "User type should be staff/client....isAdmin should be false/true",
            "schema": {
              "$ref": "#/definitions/usertype"
            }
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "The account has been updated",
            "schema": {
              "$ref": "#/definitions/usertype"
            }
          },
          "401": {
            "description": "Token expired please login again"
          },
          "403": {
            "description": "User does not have the rights to perform the operation"
          },
          "400": {
            "description": "User type is required"
          }
        }
      }
    }
  }
}