spec.json

{
  "openapi": "3.0.1",
  "info": {
    "title": "Sparesti API",
    "description": "The Sparesti API",
    "version": "3.0"
  },
  "servers": [
    {
      "url": "http://localhost:8080",
      "description": "Generated server url"
    }
  ],
  "security": [
    {
      "Bearer Authentication": []
    }
  ],
  "tags": [
    {
      "name": "Item",
      "description": "Endpoints for managing store and user inventory."
    },
    {
      "name": "Friend",
      "description": "API for managing friend relationships"
    }
  ],
  "paths": {
    "/api/users/subscription/{subscriptionLevel}": {
      "put": {
        "tags": [
          "User"
        ],
        "summary": "Update User Subscription Level",
        "description": "Updates the subscription level of the current user",
        "operationId": "updateSubscriptionLevel",
        "parameters": [
          {
            "name": "subscriptionLevel",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription level updated successfully",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/api/friends/{friendId}": {
      "put": {
        "tags": [
          "Friend"
        ],
        "summary": "Accept a friend request",
        "description": "Accepts a friend request from another user.",
        "operationId": "acceptFriendRequest",
        "parameters": [
          {
            "name": "friendId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "404": {
            "description": "Friend request not found",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "200": {
            "description": "Friend request successfully accepted",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Friend"
        ],
        "summary": "Delete a friend or cancel a friend request",
        "description": "Deletes an existing friend from your friend list or cancels a received friend request.",
        "operationId": "deleteFriendOrFriendRequest",
        "parameters": [
          {
            "name": "friendId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "404": {
            "description": "Friend or friend request not found",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "200": {
            "description": "Friend successfully deleted or friend request cancelled",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/bank/v1/transaction/norwegian-domestic-payment-to-self": {
      "post": {
        "tags": [
          "transaction-controller"
        ],
        "summary": "Transfer to account",
        "description": "Transfer money from a users account to another account of the same user",
        "operationId": "transferToSelf",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TransactionDTO"
              }
            }
          },
          "required": true
        },
        "responses": {
          "404": {
            "description": "Bank profile id does not exist",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/TransactionDTO"
                }
              }
            }
          },
          "200": {
            "description": "No accounts associated with a bank user",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/TransactionDTO"
                }
              }
            }
          }
        }
      }
    },
    "/bank/v1/profile/create-profile": {
      "post": {
        "tags": [
          "bank-profile-controller"
        ],
        "summary": "Create bank profile",
        "description": "Create a bank profile by providing a social security number",
        "operationId": "createBankProfile",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BankProfileDTO"