swagger.json

{
  "openapi": "3.0.1",
  "info": {
    "version": "0.0.1",
    "title": "Water Tracker API docs",
    "description": "API documentation for the Water Tracker project. [Backend GitHub repository](https://github.com/TokarevArtemV/water-tracker-node-rest-api)",
    "license": {
      "name": "MIT",
      "url": "https://opensource.org/licenses/MIT"
    }
  },
  "servers": [
    { "url": "http://localhost:3000" },
    { "url": "http://localhost:5000" },
    { "url": "https://water-tracker-node-rest-api.onrender.com" }
  ],
  "tags": [
    {
      "name": "Auth",
      "description": "Endpoints for user authorization"
    },
    {
      "name": "User",
      "description": "Endpoints for user management"
    },
    {
      "name": "Water",
      "description": "Endpoints for water consumption tracking"
    }
  ],
  "paths": {
    "/api/users/register": {
      "post": {
        "tags": ["Auth"],
        "summary": "User Registration",
        "requestBody": {
          "description": "Object containing user registration details",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/authSchema"
              },
              "example": {
                "email": "example@example.com",
                "password": "password123"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful user registration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/registerResponse"
                },
                "example": {
                  "email": "example@example.com",
                  "password": "password123"
                }
              }
            }
          },
          "400": {
            "description": "Bad request due to invalid request body",
            "content": {}
          },
          "409": {
            "description": "Email already in use",
            "content": {}
          }
        }
      }
    },
    "/api/users/login": {
      "post": {
        "tags": ["Auth"],
        "summary": "User Authentication",
        "requestBody": {
          "description": "Object containing user authentication details",
          "required": ["email", "password"],
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/authSchema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful user authentication",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/authResponse"
                }
              }
            }
          },
          "401": {
            "description": "Invalid email or password",
            "content": {}
          },
          "404": {
            "description": "Email not verified",
            "content": {}
          }
        }
      }
    },
    "/api/users/logout": {
      "post": {
        "tags": ["Auth"],
        "summary": "User Logout",
        "security": [{ "Bearer": [] }],
        "responses": {
          "204": {
            "description": "User successfully logged out",
            "content": {}
          },
          "400": {
            "description": "No token provided",
            "content": {}
          }
        }
      }
    },
    "/api/users/verify/{verificationToken}": {
      "get": {
        "tags": ["Auth"],
        "summary": "Verify User Email",
        "parameters": [
          {
            "name": "verificationToken",
            "in": "path",
            "required": true,
            "description": "Verification token associated with the user's email",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "302": {
            "description": "Redirect to sign-in page",
            "headers": {
              "Location": {
                "description": "URL to redirect to",
                "schema": {
                  "type": "string",
                  "example": "https://water-tracker-pi.vercel.app/signin"
                }
              }
            }
          },
          "400": {
            "description": "Verification has already been passed"
          },
          "404": {
            "description": "User not found"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/api/users/verify": {
      "post": {
        "tags": ["Auth"],
        "summary": "Resend Verification Email",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "description": "User's email"
                  }
                },
                "required": ["email"]
              },
              "example": {
                "email": "example@example.com"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Verification email sent",
            "content": {
              "application/json": {
                "example": {
                  "message": "Verification email sent"
                }
              }
            }
          },
          "400": {
            "description": "Verification has already been passed"
          },
          "404": {
            "description": "User not found"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/api/users/current": {
      "get": {
        "tags": ["User"],
        "summary": "Get user's data",
        "security": [{ "Bearer": [] }],
        "responses": {
          "200": {
            "description": "User is logged in",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/getCurrentResponse"
                },
                "example": {
                  "user": {
                    "avatarURL": "https://s.gravatar.com/avatar/66c9da6f2d374d0074a76d28d531f0af?r=pg",
                    "email": "email@email.com",
                    "gender": "female",
                    "username": "Jane",
                    "waterRate": "2000"
                  }
                }
              }
            }
          },
          "400": {
            "description": "No token provided",
            "content": {}
          }
        }
      }
    },
    "/api/users/update": {
      "put": {
        "tags": ["User"],
        "summary": "Update user data",
        "security": [{ "Bearer": [] }],
        "parameters": [],
        "requestBody": {
          "description": "Object",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/updateUserDataRequest"
              },
              "example": {
                "email": "trinity@example.com",
                "password": "password123",
                "newPassword": "password123",
                "username": "Trinity",
                "gender": "female"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/updateUserDataResponse"
                }
              }
            }
          },

          "400": {
            "description": "The new password cannot be equal to the old one"
          },
          "401": {
            "description": "Outdated password is wrong"
          },
          "404": {
            "description": "User not found"
          },
          "409": {
            "description": "Email already exist"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/api/users/avatar": {
      "patch": {
        "tags": ["User"],
        "summary": "Add or update user avatar",
        "security": [{ "Bearer": [] }],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "avatarURL": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },

        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateUserAvatarResponse"
                }
              }
            }
          },
          "400": {
            "description": "No avatar"
          },
          "404": {
            "description": "User not found"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/api/users/waterRate": {
      "patch": {
        "tags": ["User"],
        "summary": "Editing user's daily water intake norm",
        "security": [{ "Bearer": [] }],
        "parameters": [],
        "requestBody": {
          "description": "Object ",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/userWaterRateRequest"
              },
              "example": {
                "waterRate": 2400
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/userWaterRateResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },

    "/api/water-portions": {
      "post": {
        "tags": ["Water"],
        "summary": "Add water portion and time by user",
        "security": [{ "Bearer": [] }],
        "parameters": [],
        "requestBody": {
          "description": "Object which containes water volume and date ",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/addWaterRequest"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/addWaterResponse"
                }
              }
            }
          },
          "400": { "description": "Bad Request" },
          "401": {
            "description": "Unauthorized"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/api/water-portions/{id}": {
      "put": {
        "tags": ["Water"],
        "summary": "Edit water portion and time by user",
        "security": [{ "Bearer": [] }],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string",
            "description": "Water portion id"
          }
        ],
        "requestBody": {
          "description": "Object ",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/addWaterRequest"
              },
              "example": {
                "waterVolume": 143,
                "date": "2024-04-20T19:43:58.583Z"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/addWaterResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      },
      "delete": {
        "tags": ["Water"],
        "summary": "Delete water portion and time by user",
        "security": [{ "Bearer": [] }],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string",
            "description": "Water portion id"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation"
          },
          "401": {
            "description": "Unauthorized"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/api/water-portions/month": {
      "get": {
        "tags": ["Water"],
        "summary": "Get water statistic for each day of chosen month",
        "security": [{ "Bearer": [] }],
        "parameters": [
          {
            "in": "query",
            "name": "date",
            "required": true,
            "type": "string",
            "description": "Date in format 2024-04-20T19:43:58.583Z"
          }
        ],
        "responses": {
          "200": {
            "description": "Array of objects",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/getWaterStatisticResponse"
                },
                "example": [
                  {
                    "date": "16, April",
                    "percent": "53%",
                    "quantity": "3",
                    "dailyNorm": "2l"
                  },
                  {
                    "date": "17, April",
                    "percent": "50%",
                    "quantity": "2",
                    "dailyNorm": "2l"
                  }
                ]
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/api/water-portions/today": {
      "get": {
        "tags": ["Water"],
        "summary": "Get water statistic for today",
        "security": [{ "Bearer": [] }],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/getWaterTodayResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    }
  },

  "components": {
    "schemas": {
      "authSchema": {
        "type": "object",
        "required": ["email", "password"],
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "pattern": "/^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$/",
            "example": "example@example.com",
            "description": "User's email"
          },
          "password": {
            "type": "string",
            "pattern": "^[!@#$%^&*()_+\\-=[\\]{};':\"\\\\|,.<>/?\\w\\d]{8,64}$",
            "example": "password123",
            "minLength": 8,
            "maxLength": 64,
            "description": "User's password"
          }
        }
      },
      "registerResponse": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "User's email"
          },
          "verify": {
            "type": "boolean",
            "description": "Verification status"
          }
        }
      },
      "authResponse": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "description": "Authentication token",
            "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY2MWZkMmI4ZTE1MzNiOGM3YjgyMjlmOSIsImlhdCI6MTcxMzQ3NDAxOSwiZXhwIjoxNzEzNTU2ODE5fQ.GWlOBrBcLf8iMM9RdBYwuHYL5bK4e_YPWCXD7aJbanY"
          },
          "user": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "format": "email",
                "description": "User Email"
              },
              "username": {
                "type": "string",
                "description": "User Name",
                "example": "Alex"
              },
              "gender": {
                "type": "string",
                "description": "Gender",
                "enum": ["woman", "man"],
                "example": "men"
              },
              "waterRate": {
                "type": "integer",
                "description": "Water rate",
                "example": 2000
              },
              "avatarURL": {
                "type": "string",
                "description": "User's Avatar",
                "example": "https://s.gravatar.com/avatar/fe032d032b9d3530e6c9ccf9ad519004?r=pg"
              }
            }
          }
        }
      },
      "getCurrentRequest": {
        "type": "object",
        "required": ["waterRate"],
        "properties": {
          "waterRate": {
            "type": "integer",
            "description": "User's water daily norm",
            "example": "2000"
          },
          "waterVolume": {
            "type": "number",
            "description": "Volume of water recorded by the user",
            "example": "143"
          }
        }
      },
      "getCurrentResponse": {
        "type": "object",
        "properties": {
          "avaterURL": {
            "type": "string",
            "description": "User's data",
            "example": {
              "email": {
                "type": "string",
                "description": "email",
                "example": "email@email.com"
              },
              "gender": {
                "type": "string",
                "description": "gender",
                "example": "female"
              },
              "username": {
                "type": "string",
                "description": "username",
                "example": "Jane"
              },
              "waterRate": {
                "type": "integer",
                "description": "water daily norma",
                "example": "2000"
              }
            }
          }
        }
      },
      "updateUserDataRequest": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "Update user email",
            "example": "trinity@example.com"
          },
          "username": {
            "type": "string",
            "description": "Update username",
            "example": "Trinity"
          },
          "gender": {
            "type": "string",
            "description": "Gender",
            "enum": ["female", "male"],
            "example": "female"
          },
          "password": {
            "type": "string",
            "pattern": "^[!@#$%^&*()_+\\-=[\\]{};':\"\\\\|,.<>/?\\w\\d]{8,64}$",
            "example": "password123",
            "minLength": 8,
            "maxLength": 64,
            "description": "User's password"
          },
          "newPassword": {
            "type": "string",
            "pattern": "^[!@#$%^&*()_+\\-=[\\]{};':\"\\\\|,.<>/?\\w\\d]{8,64}$",
            "example": "password123",
            "minLength": 8,
            "maxLength": 64,
            "description": "User's password"
          }
        }
      },
      "updateUserDataResponse": {
        "type": "object",
        "properties": {
          "user": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "format": "email",
                "description": "Update user email",
                "example": "trinity@example.com"
              },
              "username": {
                "type": "string",
                "description": "Update username",
                "example": "Trinity"
              },
              "gender": {
                "type": "string",
                "description": "Gender",
                "enum": ["female", "male"],
                "example": "female"
              }
            }
          }
        }
      },

      "UpdateUserAvatarResponse": {
        "type": "object",
        "properties": {
          "avatarURL": {
            "type": "string",
            "description": "URL or path to user's avatar",
            "example": "https://res.cloudinary.com/daml0j4xo/image/upload/v1713910200/avatars/wm0xv0cwuollymh8kjmi.png"
          }
        }
      },
      "userWaterRateRequest": {
        "type": "object",
        "required": ["waterRate"],
        "properties": {
          "waterRate": {
            "type": "number",
            "description": "The daily intake volume specified by the user in milliliters",
            "example": 2100
          }
        }
      },
      "userWaterRateResponse": {
        "type": "object",
        "items": {
          "type": "object",
          "properties": {
            "waterRate": {
              "type": "number",
              "description": "User-chosen daily norm",
              "example": 2100
            }
          }
        },
        "example": {
          "waterRate": 2100
        }
      },
      "addWaterRequest": {
        "type": "object",
        "required": ["date", "waterVolume"],
        "properties": {
          "date": {
            "type": "string",
            "description": "Recording time",
            "example": "2024-04-20T19:43:58.583Z"
          },
          "waterVolume": {
            "type": "number",
            "description": "Volume of water recorded by the user",
            "example": "143"
          }
        }
      },
      "addWaterResponse": {
        "type": "object",
        "properties": {
          "waterVolume": {
            "type": "number",
            "description": "Volume of water recorded by the user",
            "example": "143"
          },
          "date": {
            "type": "string",
            "description": "Recording time",
            "example": "2024-04-20T19:43:58.583Z"
          },
          "owner": {
            "type": "string",
            "description": "Owner of the entered data",
            "example": "661d611659151681f4efe804"
          },
          "_id": {
            "type": "string",
            "description": "Id of the entered data",
            "example": "66241b0b9546fc64382d529a"
          }
        },
        "example": {
          "waterVolume": "143",
          "date": "2024-04-20T19:43:58.583Z",
          "owner": "661d611659151681f4efe804",
          "_id": "66241b0b9546fc64382d529a"
        }
      },
      "getWaterStatisticResponse": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "Chosen month and year",
            "example": "2024-04-20T19:43:58.583Z"
          },
          "percent": {
            "type": "string",
            "description": "Percent of daily norm achievement",
            "example": "53%"
          },
          "quantity": {
            "type": "string",
            "description": "Quantity of daily records",
            "example": "3"
          },
          "dailyNorm": {
            "type": "number",
            "description": "Daily norm for certain day",
            "example": "2L"
          }
        },
        "example": {
          "date": "2024-04-20T19:43:58.583Z",
          "percent": "53%",
          "quantity": "3",
          "dailyNorm": "2L"
        }
      },
      "getWaterTodayResponse": {
        "type": "Object",
        "items": {
          "type": "object",
          "properties": {
            "data": [
              {
                "dailyNorm": {
                  "type": "number",
                  "description": "User-chosen daily norm",
                  "example": "2100"
                },
                "date": {
                  "type": "string",
                  "description": "Time selected by the user when adding a water portion",
                  "example": "2024-04-20T19:43:58.583Z"
                },
                "owner": {
                  "type": "string",
                  "description": "Owner of the entered data",
                  "example": "661d611659151681f4efe804"
                },
                "waterVolume": {
                  "type": "number",
                  "description": "Water volume recorded by the user in this portion",
                  "example": "250"
                },
                "_id": {
                  "type": "string",
                  "description": "Id of the entered data",
                  "example": "66241b0b9546fc64382d529a"
                }
              }
            ]
          }
        },
        "example": {
          "data": [
            {
              "dailyNorm": "2100",
              "date": "2024-04-23T11:39:52.555Z",
              "owner": "661fd2b8e1533b8c7b8229f9",
              "waterVolume": "250",
              "_id": "66279e0c0908890cd1d204be"
            }
          ],
          "interest": 11.9047619
        }
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}