swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Logs Center API",
    "description": "Store and retrieve application logs from other applications",
    "version": "1.1.1",
    "license": {
      "name": "MIT",
      "url": "http://opensource.org/licenses/MIT"
    }
  },
  "host": "api-central-de-logs.herokuapp.com",
  "basePath": "/",
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "tags": [
    {
      "name": "User",
      "description": "routes"
    },
    {
      "name": "Logs",
      "description": "routes"
    }
  ],
  "paths": {
    "/user/signup": {
      "post": {
        "tags": [
          "User"
        ],
        "summary": "Create user",
        "description": "Create a new user account to get access to the API",
        "parameters": [
          {
            "in": "body",
            "name": "User credentials",
            "schema": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "Example User"
                },
                "email": {
                  "type": "string",
                  "example": "user@email.com.br"
                },
                "password": {
                  "type": "string",
                  "example": "123456"
                }
              }
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Returns confirmation of the created user",
            "schema": {
              "$ref": "#/userCreatedSuccessfully"
            }
          },
          "406": {
            "description": "Returns the message stating that the data sent is invalid",
            "schema": {
              "$ref": "#/invalidData"
            }
          },
          "409": {
            "description": "Returns the message stating that the email already exists",
            "schema": {
              "$ref": "#/userEmailAlreadyExists"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/user/signin": {
      "post": {
        "tags": [
          "User"
        ],
        "summary": "User login authenticate",
        "description": "Authenticate an existing user returning a token for API requests",
        "parameters": [
          {
            "in": "body",
            "name": "User credentials",
            "schema": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "format": "email",
                  "example": "user@email.com.br"
                },
                "password": {
                  "type": "string",
                  "format": "password",
                  "example": "123456"
                }
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the token",
            "schema": {
              "$ref": "#/token"
            }
          },
          "400": {
            "description": "Returns bad request",
            "schema": {
              "$ref": "#/userNotFound"
            }
          },
          "401": {
            "description": "Returns unauthorized",
            "schema": {
              "$ref": "#/incorrectPassword"
            }
          },
          "406": {
            "description": "Returns not acceptable",
            "schema": {
              "$ref": "#/invalidData"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/user/restore": {
      "post": {
        "tags": [
          "User"
        ],
        "summary": "User login",
        "description": "Authenticate an existing user returning a token for API requests",
        "parameters": [
          {
            "in": "body",
            "name": "User credentials",
            "schema": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "format": "email",
                  "example": "user@email.com.br"
                },
                "password": {
                  "type": "string",
                  "format": "password",
                  "example": "123456"
                }
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns OK",
            "schema": {
              "$ref": "#/userRestoredSuccessfully"
            }
          },
          "204": {
            "description": "Returns no content",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "401": {
            "description": "Returns unauthorized",
            "schema": {
              "$ref": "#/incorrectPassword"
            }
          },
          "406": {
            "description": "Returns not acceptable",
            "schema": {
              "$ref": "#/invalidData"
            }
          }
        },
        "500": {
          "description": "Returns the message stating that an error has occurred on the server",
          "schema": {
            "$ref": "#/internalServerError"
          }
        }
      }
    },
    "/user": {
      "patch": {
        "tags": [
          "User"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Update user",
        "description": "Update an authenticated user with the new information provided in request body",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          },
          {
            "in": "body",
            "name": "User data to be updated",
            "schema": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "Updated User"
                },
                "email": {
                  "type": "string",
                  "example": "updateduser@email.com.br"
                },
                "oldPassword": {
                  "type": "string",
                  "example": "123456"
                },
                "newPassword": {
                  "type": "string",
                  "example": "12345678"
                },
                "confirmPassword": {
                  "type": "string",
                  "example": "12345678"
                }
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/updatedSuccessfully"
            }
          },
          "401": {
            "description": "Returns unauthorized",
            "schema": {
              "$ref": "#/invalidToken"
            }
          },
          "403": {
            "description": "Returns forbidden",
            "schema": {
              "$ref": "#/tokenNotProvided"
            }
          },
          "406": {
            "description": "Returns Not Acceptable",
            "schema": {
              "$ref": "#/invalidData"
            }
          },
          "412": {
            "description": "Precondition failed",
            "schema": {
              "$ref": "#/passwordDoesNotMatch"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "User"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Disable user",
        "description": "Executes a soft delete disabling the user account",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the message stating that the user has been deleted",
            "schema": {
              "$ref": "#/delete"
            }
          },
          "204": {
            "description": "Returns an empty object signaling that the user no longer exists",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/user/hard": {
      "delete": {
        "tags": [
          "User"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Delete user forever",
        "description": "Remove user account and all the logs associated with it from the database. This action cannot be undone. The user id will be provided by the token.",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the body with a message of deletation",
            "schema": {
              "$ref": "#/permanentDelete"
            }
          },
          "204": {
            "description": "Returns an empty object signaling that the user no longer exists",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/logs/sender/{senderApplication}": {
      "get": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get logs by application",
        "description": "Get all the logs for the application passed in the url parameter",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          },
          {
            "in": "path",
            "name": "senderApplication",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Application name"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns all logs by application",
            "schema": {
              "$ref": "#/logWithTotal"
            }
          },
          "204": {
            "description": "There are no records for the reported application",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/logs/environment/{environment}": {
      "get": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get logs by environment",
        "description": "Get all logs of an environment that is passed in the url parameter",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          },
          {
            "in": "path",
            "name": "environment",
            "schema": {
              "type": "string",
              "required": true,
              "example": "homologation"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns all logs by environment",
            "schema": {
              "$ref": "#/logWithTotal"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          },
          "204": {
            "description": "Returns an empty object, signaling that there are no logs to display for this use",
            "schema": {
              "$ref": "#/noContent"
            }
          }
        }
      }
    },
    "/logs/level/{level}": {
      "get": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get logs by level",
        "description": "Get all the logs with the same level passed in the url parameter",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          },
          {
            "in": "path",
            "name": "level",
            "schema": {
              "type": "string",
              "required": true,
              "example": "WARN"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns all logs by level",
            "schema": {
              "$ref": "#/logWithTotal"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          },
          "204": {
            "description": "Returns the message stating that there are no logs",
            "schema": {
              "$ref": "#/noContent"
            }
          }
        }
      }
    },
    "/logs": {
      "get": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get all logs by user",
        "description": "Bring all logs registered by the user",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the logs ",
            "schema": {
              "type": "object",
              "properties": {
                "total": {
                  "type": "number",
                  "example": 1
                },
                "Logs": {
                  "type": "array",
                  "items": {
                    "$ref": "#/definitions/Log"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Returns unauthorized",
            "schema": {
              "$ref": "#/invalidToken"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          },
          "204": {
            "description": "Returns an empty object, signaling that there are no logs to display",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "403": {
            "description": "Returns forbidden",
            "schema": {
              "$ref": "#/tokenNotProvided"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Create logs",
        "description": "Creates a new log associated with a user. The user id is provided by the token.",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          },
          {
            "in": "body",
            "name": "Logs body",
            "schema": {
              "type": "object",
              "properties": {
                "level": {
                  "type": "string",
                  "example": "WARN"
                },
                "description": {
                  "type": "string",
                  "example": "Application restarted"
                },
                "senderApplication": {
                  "type": "string",
                  "example": "Application name"
                },
                "sendDate": {
                  "type": "string",
                  "example": "11/26/2019 15:00"
                },
                "environment": {
                  "type": "string",
                  "example": "homologation"
                }
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the created log",
            "schema": {
              "$ref": "#/onlyTheLog"
            }
          },
          "406": {
            "description": "Returns not acceptable",
            "schema": {
              "$ref": "#/invalidData"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/logs/restore/id/{id}": {
      "post": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Restore a log",
        "description": "Restore a log by an informed ID",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          },
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string",
              "required": true,
              "example": "1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the confirmation of the restored log",
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "example": "Log restored successfully"
                }
              }
            }
          },
          "204": {
            "description": "Returns an empty object, signaling that there are no logs to display",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/logs/restore/all": {
      "post": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Restore all logs",
        "description": "Restore all logs created by the user",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a succesfull message when all logs of an user are restored",
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "example": "All logs restored successfully"
                }
              }
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          },
          "204": {
            "description": "Returns an empty object, signaling that there are no logs to display",
            "schema": {
              "$ref": "#/noContent"
            }
          }
        }
      }
    },
    "/logs/id/{id}": {
      "delete": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Soft delete log",
        "description": "Delete the log with the id passed in the url",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          },
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string",
              "required": true,
              "example": "1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the message stating that the log has been deleted",
            "schema": {
              "$ref": "#/logDelete"
            }
          },
          "204": {
            "description": "Returns an empty object, signaling that there are no logs to delete",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/logs/all": {
      "delete": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Soft Delete for all logs from user",
        "description": "Delete al the logs from a user. The user id will be provided by the token.",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the body with a message of deletation",
            "schema": {
              "$ref": "#/deletionOfAllLogs"
            }
          },
          "204": {
            "description": "Returns an empty object, signaling that there are no logs to delete",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "401": {
            "description": "Returns unauthorized",
            "schema": {
              "$ref": "#/invalidToken"
            }
          },
          "403": {
            "description": "Returns forbidden",
            "schema": {
              "$ref": "#/tokenNotProvided"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/logs/hard/{id}": {
      "delete": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Permanently deletes the user log",
        "description": "Delete the log. The log id will be provided by the token.",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          },
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string",
              "required": true,
              "example": "1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Remove the log with the matching ID if it existed previously. Otherwise do nothing.",
            "schema": {
              "$ref": "#/permanentLogDelete"
            }
          },
          "204": {
            "description": "Returns an empty object, signaling that there are no logs to delete",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    },
    "/logs/all/hard": {
      "delete": {
        "tags": [
          "Logs"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Permanently deletes all user logs",
        "description": "Delete al the logs from a user forever. This action cannot be undone. The user id will be provided by the token.",
        "parameters": [
          {
            "in": "header",
            "name": "Authorization",
            "description": "Provide the Authorization header using the Bearer scheme",
            "schema": {
              "type": "string",
              "required": true,
              "example": "Bearer wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the body with a message of deletation",
            "schema": {
              "$ref": "#/permanentDeletionOfAllLogs"
            }
          },
          "204": {
            "description": "Returns an empty object, signaling that there are no logs to delete",
            "schema": {
              "$ref": "#/noContent"
            }
          },
          "401": {
            "description": "Returns unauthorized",
            "schema": {
              "$ref": "#/invalidToken"
            }
          },
          "403": {
            "description": "Returns forbidden",
            "schema": {
              "$ref": "#/tokenNotProvided"
            }
          },
          "500": {
            "description": "Returns the message stating that an error has occurred on the server",
            "schema": {
              "$ref": "#/internalServerError"
            }
          }
        }
      }
    }
  },
  "userCreatedSuccessfully": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "User created successfully"
      }
    }
  },
  "invalidData": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Invalid data"
      }
    }
  },
  "userEmailAlreadyExists": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "User email already exists"
      }
    }
  },
  "internalServerError": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Internal server error"
      }
    }
  },
  "token": {
    "type": "object",
    "properties": {
      "token": {
        "type": "string",
        "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOnsiaWQiOjJ9LCJpYXQiOjE1ODUxNjkwMjMsImV4cCI6MTU4NTI1NTQyM30.wgioiERBtXR6CXppvSyKV0MhFu28TKgfw94JvNEuDHA"
      }
    }
  },
  "userNotFound": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "User not found"
      }
    }
  },
  "incorrectPassword": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Incorrect password"
      }
    }
  },
  "userRestoredSuccessfully": {
    "type": "object",
    "properties": {
      "token": {
        "type": "string",
        "example": "User restored successfully"
      }
    }
  },
  "noContent": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "{}"
      }
    }
  },
  "updatedSuccessfully": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Updated sucessfully"
      }
    }
  },
  "passwordDoesNotMatch": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Password does not match"
      }
    }
  },
  "invalidToken": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Invalid token"
      }
    }
  },
  "tokenNotProvided": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Token not provided"
      }
    }
  },
  "delete": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Deleted successfully"
      }
    }
  },
  "permanentDelete": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Deleted successfully, this action cannot be undone"
      }
    }
  },
  "logWithTotal": {
    "type": "object",
    "properties": {
      "total": {
        "type": "number",
        "example": 1
      },
      "Logs": {
        "type": "array",
        "items": {
          "$ref": "#/onlyTheLog"
        }
      }
    }
  },
  "onlyTheLog": {
    "type": "object",
    "properties": {
      "createdLog": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "example": 1
          },
          "level": {
            "type": "string",
            "example": "WARN"
          },
          "description": {
            "type": "string",
            "example": "Application restarted"
          },
          "senderApplication": {
            "type": "string",
            "example": "Application name"
          },
          "sendDate": {
            "type": "string",
            "example": "11/26/2019 15:00"
          },
          "environment": {
            "type": "string",
            "example": "homologation"
          },
          "UserId": {
            "type": "number",
            "example": 1
          },
          "updatedAt": {
            "type": "date-time",
            "example": "2020-03-26T00:21:40.039Z"
          },
          "createdAt": {
            "type": "date-time",
            "example": "2020-03-26T00:21:40.039Z"
          }
        }
      }
    }
  },
  "logDelete": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Deleted successfully"
      }
    }
  },
  "deletionOfAllLogs": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Deleted successfully"
      }
    }
  },
  "permanentLogDelete": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Deleted successfully, this action cannot be undone"
      }
    }
  },
  "permanentDeletionOfAllLogs": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "example": "Deleted successfully, this action cannot be undone"
      }
    }
  },
  "definitions": {
    "User": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "example": 1
        },
        "name": {
          "type": "string",
          "example": "Example User"
        },
        "email": {
          "type": "string",
          "example": "user@email.com.br"
        },
        "password": {
          "type": "string",
          "format": "password",
          "example": "652a80db6fab5930dabf7d4fb7db5d67"
        }
      },
      "required": [
        "name",
        "email",
        "password"
      ]
    },
    "Log": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "example": 1
        },
        "level": {
          "type": "string",
          "enum": [
            "FATAL",
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG",
            "TRACE",
            "ALL",
            "OFF"
          ],
          "example": "WARN"
        },
        "description": {
          "type": "string",
          "example": "Application restarted"
        },
        "senderApplication": {
          "type": "string",
          "example": "Application name"
        },
        "sendDate": {
          "type": "string"
        },
        "environment": {
          "type": "string",
          "enum": [
            "production",
            "homologation"
          ],
          "example": "homologation"
        },
        "userId": {
          "type": "integer",
          "example": 1
        }
      },
      "required": [
        "level",
        "description",
        "senderApplication",
        "sendDate",
        "environment",
        "userId"
      ]
    }
  }
}