swagger.json

{
  "openapi": "3.0.1",
  "info": {
    "version": "0.0.1",
    "title": "Dreamteam water",
    "description": "Water Consumption Accounting Program",
    "license": {
      "name": "MIT",
      "url": "https://opensource.org/licenses/MIT"
    }
  },
  "consumes": [
    "application/json",
    "multipart/form-data",
    "image/png"
  ],
  "produces": [
    "application/json",
    "multipart/form-data",
    "image/png"
  ],
  "servers": [
    {
      "url": "http://localhost:3000",
      "description": "Local"
    },
    {
      "url": "https://dreamteam-water-server.onrender.com",
      "description": "Main"
    }
  ],
  "tags": [
    {
      "name": "Auth",
      "description": "Authentication - endpoints including user registration, login, authorization and logout"
    },
    {
      "name": "User",
      "description": "SUser - endpoints for managing user information, including avatar, profile viewing, and updates"
    },
    {
      "name": "Water",
      "description": "Water Consumption Calculation - endpoint for updating the daily water consumption norm for users. Water - endpoints for managing water consumption records, including adding, editing, and deleting entries. Today - endpoint for retrieving information about water consumed on the current day. Month - endpoint for retrieving monthly water consumption data."
    }
  ],
  "paths": {
    "/api/users/register": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Create a new user",
        "parameters": [],
        "requestBody": {
          "description": "Registration's object",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/authSchema"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/responseAuth"
                }
              }
            }
          },
          "400": {
            "description": "missing fields"
          },
          "409": {
            "description": "Email in use"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/users/login": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "User login",
        "parameters": [],
        "requestBody": {
          "description": "Login object",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/authSchema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation - User is logged in",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/responseLogin"
                }
              }
            }
          },
          "400": {
            "description": "missing fields"
          },
          "401": {
            "description": "Need to email verification or Email or password is wrong"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/users/logout": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Log out user",
        "parameters": [],
        "security": [
          {
            "Bearer": []
          }
        ],
        "responses": {
          "204": {
            "description": "Logout success"
          },
          "401": {
            "description": "Not authorized"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/users/current": {
      "get": {
        "tags": [
          "User"
        ],
        "summary": "Get information about the current user",
        "parameters": [],
        "security": [
          {
            "Bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/responseGetCurrentUser"
                }
              }
            }
          },
          "401": {
            "description": "Not authorized"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/users/avatars": {
      "patch": {
        "tags": [
          "User"
        ],
        "summary": "Update user avatar",
        "security": [
          {
            "Bearer": []
          }
        ],
        "parameters": [],
        "requestBody": {
          "description": "User avatar object",
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/requestUpdateAvatarUser"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "avatarURL": {
                      "type": "string",
                      "format": "uri",
                      "example": "http://res.cloudinary.com/dykzy8ppw/image/upload/v1707049114/dreamTeamWater/65baa642572064935b2456у5.png"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Missing fields"
          },
          "401": {
            "description": "Not authorized"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/users/verify/{verificationToken}": {
      "get": {
        "tags": [
          "Auth"
        ],
        "summary": "Update user token",
        "parameters": [
          {
            "name": "verificationToken",
            "in": "path",
            "required": true,
            "description": "Verification token of the user",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Verification successful",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Verification successful"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Not authorized"
          },
          "404": {
            "description": "User not found"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/users/verify": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Verify user Email",
        "parameters": [],
        "security": [
          {
            "Bearer": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "description": "User's email"
                  }
                },
                "required": [
                  "email"
                ]
              },
              "example": {
                "email": "testUser@gmail.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"
          }
        }
      }
    },
    "/api/users/info": {
      "get": {
        "tags": [
          "User"
        ],
        "summary": "Get information about the current user",
        "parameters": [],
        "security": [
          {
            "Bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/responseGetUserInfo"
                }
              }
            }
          },
          "401": {
            "description": "Not authorized"
          },
          "500": {
            "description": "Server error"
          }
        }
      },
      "patch": {
        "tags": [
          "User"
        ],
        "summary": "Path information about the current user",
        "parameters": [],
        "security": [
          {
            "Bearer": []
          }
        ],
        "requestBody": {
          "description": "Login object",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/requestUpdateInfoUser"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/responseUpdateInfoUser"
                }
              }
            }
          },
          "401": {
            "description": "Not authorized"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/water": {
      "post": {
        "tags": [
          "Water"
        ],
        "summary": "Get information for the specified day",
        "description": "Retrieves water consumption records for the current user for the specified date.",
        "security": [
          {
            "Bearer": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string",
                    "format": "date-time",
                    "description": "The date to retrieve water consumption information for, in ISO format."
                  }
                },
                "required": [
                  "date"
                ]
              },
              "example": {
                "date": "2023-01-01T00:00:00.000Z"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successfully retrieved the water consumption information for the specified date.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "dayInfo": {
                      "$ref": "#/components/schemas/DayInfo"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Missing fields"
          },
          "401": {
            "description": "Not authorized"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/water/drinks/{dayId}": {
      "post": {
        "tags": [
          "Water"
        ],
        "summary": "Add a new drink to the current day",
        "description": "Add a new drink to the current day",
        "security": [
          {
            "Bearer": []
          }
        ],
        "operationId": "addDrink",
        "parameters": [
          {
            "name": "dayId",
            "in": "path",
            "required": true,
            "description": "ID of the day to add the drink to",
            "schema": {
              "type": "string",
              "example": "65b55865b6b2ac88bc55a78y"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddDrinkRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WaterDayResponse"
                }
              }
            }
          },
          "404": {
            "description": "The day not found"
          }
        }
      }
    },
    "/api/water/drinks/{id}": {
      "patch": {
        "tags": [
          "Water"
        ],
        "summary": "Edit an existing drink entry for the current day",
        "description": "Edit details of a specific drink entry.",
        "security": [
          {
            "Bearer": []
          }
        ],
        "operationId": "EditDrink",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "ID of the day to edit the drink to",
            "schema": {
              "type": "string",
              "example": "65b55865b6b2ac88bc55a78y"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddDrinkRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WaterDayResponse"
                }
              }
            }
          },
          "404": {
            "description": "The day not found"
          }
        }
      },
      "delete": {
        "tags": [
          "Water"
        ],
        "summary": "Delete a specific drink",
        "description": "Deletes a specific drink entry based on the provided ID.",
        "security": [
          {
            "Bearer": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "ID of drink to delete",
            "schema": {
              "type": "string",
              "example": "65b55865b6b2ac88bc55a78y"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WaterDayResponse"
                }
              }
            }
          },
          "404": {
            "description": "The day not found"
          }
        }
      }
    },
    "/api/water/month": {
      "post": {
        "tags": [
          "Water"
        ],
        "summary": "Get information for the month",
        "description": "Retrieves water consumption records for the specified month for the current user.",
        "security": [
          {
            "Bearer": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "year",
                  "month"
                ],
                "properties": {
                  "year": {
                    "type": "string",
                    "description": "The year for which to retrieve water consumption information, formatted as YYYY.",
                    "example": "2024"
                  },
                  "month": {
                    "type": "string",
                    "description": "The month for which to retrieve water consumption information, formatted as MM.",
                    "example": "02"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successfully retrieved the water consumption information for the specified date.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MonthWaterResponse"
                }
              }
            }
          },
          "400": {
            "description": "Missing fields"
          },
          "401": {
            "description": "Not authorized"
          },
          "404": {
            "description": "The month not found"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/water/norm": {
      "patch": {
        "tags": [
          "Water"
        ],
        "summary": "Edit the water consumption norm",
        "description": "Updates the daily water consumption norm for the current user.",
        "security": [
          {
            "Bearer": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "norm"
                ],
                "properties": {
                  "date": {
                    "type": "string",
                    "format": "date-time",
                    "description": "The specific date for which water consumption data is provided.",
                    "example": "2023-01-01T00:00:00.000Z"
                  },
                  "norm": {
                    "type": "integer",
                    "description": "The new daily water consumption norm in milliliters.",
                    "example": 1000
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successfully updated the water consumption norm.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WaterDayResponse"
                }
              }
            }
          },
          "400": {
            "description": "Missing fields"
          },
          "401": {
            "description": "Not authorized or Incorrect norm (need <=15000)"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "authSchema": {
        "type": "object",
        "required": [
          "email",
          "password"
        ],
        "properties": {
          "email": {
            "type": "string",
            "pattern": "^\\w+([\\.-]?\\w+)*@\\w+([\\.-]?\\w+)*(\\.\\w{2,3})+$",
            "example": "testUser@gmail.com"
          },
          "password": {
            "type": "string",
            "minLength": 8,
            "maxLength": 64,
            "example": "test1234"
          }
        }
      },
      "responseAuth": {
        "type": "object",
        "properties": {
          "user": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique identifier of the user",
                "example": "65b55865b6b2ac84bc52a78y"
              },
              "email": {
                "type": "string",
                "format": "email",
                "description": "Email address of the user",
                "example": "testUser@gmail.com"
              }
            }
          }
        }
      },
      "responseLogin": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "description": "Authentication token",
            "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
          },
          "user": {
            "type": "object",
            "properties": {
              "_id": {
                "type": "string",
                "description": "ID of the user",
                "example": "65baa642572064935b2456h7"
              },
              "email": {
                "type": "string",
                "format": "email",
                "description": "Email of the user"
              },
              "name": {
                "type": "string",
                "description": "Name of the user",
                "example": "UserFirst"
              },
              "gender": {
                "type": "string",
                "description": "Gender of the user",
                "enum": [
                  "woman",
                  "man"
                ],
                "example": "woman"
              },
              "norm": {
                "type": "number",
                "description": "User's daily norm",
                "example": "2000"
              },
              "avatarURL": {
                "type": "string",
                "description": "URL of the user's avatar",
                "example": "avatars/65b55865b6b2ac84bc52a78f.jpg"
              },
              "startDay": {
                "type": "number",
                "description": "User's daily norm",
                "example": null
              }
            }
          }
        }
      },
      "responseGetCurrentUser": {
        "type": "object",
        "properties": {
          "user": {
            "type": "object",
            "required": [
              "_id",
              "email",
              "name",
              "avatarURL"
            ],
            "properties": {
              "_id": {
                "type": "string",
                "example": "65baa642572064935b2456b6"
              },
              "email": {
                "type": "string",
                "example": "testUser@gmail.com"
              },
              "name": {
                "type": "string",
                "example": "UserFirst"
              },
              "gender": {
                "type": "string",
                "description": "Gender of the user",
                "enum": [
                  "woman",
                  "man"
                ],
                "example": "woman"
              },
              "avatarURL": {
                "type": "string",
                "example": "http://res.cloudinary.com/dykzy8ppw/image/upload/v1707049114/dreamTeamWater/65baa642572064935b245611.png"
              },
              "startDay": {
                "type": "string",
                "format": "date-time",
                "description": "The day the user started",
                "example": "2023-01-01T00:00:00.000Z"
              }
            }
          }
        }
      },
      "requestUpdateAvatarUser": {
        "type": "object",
        "properties": {
          "avatar": {
            "type": "string",
            "format": "binary",
            "description": "File avatar",
            "example": "avatars/65b55865b6b2ac84bc52a78f.jpg"
          }
        }
      },
      "responseGetUserInfo": {
        "type": "object",
        "required": [
          "_id",
          "email",
          "name",
          "gender"
        ],
        "properties": {
          "_id": {
            "type": "string",
            "example": "65b55865b6b2ac84bc52a78y"
          },
          "email": {
            "type": "string",
            "example": "testUser@gmail.com"
          },
          "name": {
            "type": "string",
            "example": "UserFirst"
          },
          "gender": {
            "type": "string",
            "description": "Gender of the user",
            "enum": [
              "woman",
              "man"
            ],
            "example": "woman"
          }
        }
      },
      "requestUpdateInfoUser": {
        "type": "object",
        "required": [
          "name",
          "email",
          "gender"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "UserFirst"
          },
          "email": {
            "type": "string",
            "example": "testUser@gmail.com"
          },
          "gender": {
            "type": "string",
            "description": "Gender of the user",
            "enum": [
              "woman",
              "man"
            ],
            "example": "woman"
          },
          "password": {
            "type": "string",
            "minLength": 8,
            "maxLength": 64,
            "description": "Current password of the user. Required only if changing the password.",
            "example": "test1234"
          },
          "newPassword": {
            "type": "string",
            "minLength": 8,
            "maxLength": 64,
            "description": "New password for the user. Requires 'password' to be present in the request.",
            "example": "test6789"
          }
        }
      },
      "responseUpdateInfoUser": {
        "type": "object",
        "required": [
          "name",
          "email",
          "gender",
          "password"
        ],
        "properties": {
          "_id": {
            "type": "string",
            "example": "65b55865b6b2ac84bc52a78y"
          },
          "email": {
            "type": "string",
            "example": "testUser@gmail.com"
          },
          "name": {
            "type": "string",
            "example": "UserFirst"
          },
          "gender": {
            "type": "string",
            "description": "Gender of the user",
            "enum": [
              "woman",
              "man"
            ],
            "example": "woman"
          },
          "norm": {
            "type": "string",
            "example": "2000"
          },
          "avatarURL": {
            "type": "string",
            "example": "avatars/65b55865b6b2ac84bc52a78f.jpg"
          },
          "startDay": {
            "type": "number",
            "description": "User's daily norm",
            "example": null
          }
        }
      },
      "DayInfo": {
        "type": "object",
        "required": [
          "_id",
          "date",
          "norm",
          "percent",
          "drinks",
          "owner",
          "startDay"
        ],
        "properties": {
          "_id": {
            "type": "string",
            "description": "ID day info",
            "example": "65b55865b6b2ac88bc52a78y"
          },
          "date": {
            "type": "string",
            "format": "date-time",
            "description": "The specific date for which water consumption data is provided.",
            "example": "2023-01-01T00:00:00.000Z"
          },
          "norm": {
            "type": "integer",
            "description": "The daily water consumption norm for the user in milliliters.",
            "example": 2000
          },
          "percent": {
            "type": "number",
            "format": "float",
            "description": "The percentage of the daily norm that has been consumed.",
            "example": 37.5
          },
          "drinks": {
            "type": "array",
            "description": "Array of water consumption records for the day.",
            "items": {
              "type": "object",
              "properties": {
                "time": {
                  "type": "string",
                  "format": "string",
                  "description": "The time when the water was consumed.",
                  "example": "8:14 AM"
                },
                "ml": {
                  "type": "integer",
                  "description": "Amount of water consumed at this time, in milliliters.",
                  "example": 250
                },
                "_id": {
                  "type": "string",
                  "description": "ID one drink",
                  "example": "65b55865b6b2ac84bc52a56y"
                }
              }
            },
            "example": [
              {
                "ml": "250",
                "time": "7:33 AM",
                "_id": "65b55111b6b2ac84bc52a56y"
              },
              {
                "ml": "500",
                "time": "10:33 AM",
                "_id": "65b33111b6b2ac84bc52a56y"
              }
            ]
          },
          "owner": {
            "type": "string",
            "description": "Users ID",
            "example": "65b55865b6b2ac84bc52a78y"
          },
          "startDay": {
            "type": "string",
            "format": "date-time",
            "description": "The start date of the current period being analyzed.",
            "example": "2023-01-01T00:00:00.000Z"
          }
        }
      },
      "AddDrinkRequest": {
        "type": "object",
        "required": [
          "ml",
          "time"
        ],
        "properties": {
          "ml": {
            "type": "number",
            "description": "Amount of water to add in milliliters",
            "example": "250"
          },
          "time": {
            "type": "string",
            "description": "Time at which the water is drunk",
            "example": "7:33 AM"
          }
        }
      },
      "WaterDayResponse": {
        "type": "object",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Unique identifier of the day",
            "example": "65b55865b6b2ac00bc52a78y"
          },
          "date": {
            "type": "string",
            "format": "date-time",
            "description": "The specific date for which water consumption data is provided.",
            "example": "2023-01-01T00:00:00.000Z"
          },
          "norm": {
            "type": "integer",
            "description": "The daily water consumption norm for the user in milliliters.",
            "example": 2000
          },
          "percent": {
            "type": "number",
            "format": "float",
            "description": "The percentage of the daily norm that has been consumed.",
            "example": 37.5
          },
          "drinks": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "ml": {
                  "type": "number",
                  "description": "Amount of water drunk in milliliters",
                  "example": "250"
                },
                "time": {
                  "type": "string",
                  "description": "Time when the water was drunk",
                  "example": "7:33 AM"
                },
                "_id": {
                  "type": "string",
                  "description": "ID one drink",
                  "example": "65b55865b6b2ac84bc52a44y"
                }
              }
            }
          },
          "owner": {
            "type": "string",
            "description": "Users ID",
            "example": "65b55865b6b2ac84bc52a78y"
          }
        }
      },
      "MonthWaterResponse": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "day": {
              "type": "string",
              "format": "date-time",
              "description": "The specific day of the water consumption record in ISO 8601 format.",
              "example": "2024-02-02T00:00:00.000Z"
            },
            "percent": {
              "type": "number",
              "description": "The percentage of the daily water consumption norm that has been consumed.",
              "example": 20
            },
            "norm": {
              "type": "integer",
              "description": "The daily water consumption norm for the user in milliliters.",
              "example": 2000
            },
            "drinks": {
              "type": "integer",
              "description": "The number of drinks recorded for the day.",
              "example": 3
            }
          }
        }
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}