Documentation
¶
Index ¶
- func CORSMiddleware() gin.HandlerFunc
- func NewErrorResponse(c *gin.Context, statusCode int, message string)
- func NewServerErrorResponse(c *gin.Context, statusCode int, message string)
- type Handler
- func (h *Handler) AddList(c *gin.Context)
- func (h *Handler) AddSubtask(c *gin.Context)
- func (h *Handler) AddTask(c *gin.Context)
- func (h *Handler) DeleteList(c *gin.Context)
- func (h *Handler) DeleteSubtask(c *gin.Context)
- func (h *Handler) DeleteTask(c *gin.Context)
- func (h *Handler) DeleteUser(c *gin.Context)
- func (h *Handler) DeleteUserIcon(c *gin.Context)
- func (h *Handler) EditList(c *gin.Context)
- func (h *Handler) EditSubtask(c *gin.Context)
- func (h *Handler) EditTask(c *gin.Context)
- func (h *Handler) EditUserName(c *gin.Context)
- func (h *Handler) EditUserUsername(c *gin.Context)
- func (h *Handler) GetUserData(c *gin.Context)
- func (h *Handler) GetUserDataByToken(c *gin.Context)
- func (h *Handler) GetUserIcon(c *gin.Context)
- func (h *Handler) InitRoutes() *gin.Engine
- func (h *Handler) ResetUserEmail(c *gin.Context)
- func (h *Handler) ResetUserPassword(c *gin.Context)
- func (h *Handler) ShowLists(c *gin.Context)
- func (h *Handler) ShowSubtasks(c *gin.Context)
- func (h *Handler) ShowTasks(c *gin.Context)
- func (h *Handler) SignIn(c *gin.Context)
- func (h *Handler) SignUp(c *gin.Context)
- func (h *Handler) UpdateUserEmail(c *gin.Context)
- func (h *Handler) UpdateUserIcon(c *gin.Context)
- func (h *Handler) UpdateUserPassword(c *gin.Context)
- func (h *Handler) UpdateUserToken(c *gin.Context)
- func (h *Handler) VerifySignUp(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CORSMiddleware ¶
func CORSMiddleware() gin.HandlerFunc
Types ¶
type Handler ¶
type Handler struct {
PostgresDB db.PostgresDB
RedisClient db.RedisClient
MinIOClient db.MinIOClient
EmailAuthData common.EmailProvider
}
func (*Handler) AddList ¶
@Summary Create list @Tags Working with lists @Accept json @Produce json @Param ListData body models.ApiListData true "List data" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/list/add [post]
func (*Handler) AddSubtask ¶
@Summary Create subtask @Tags Working with subtasks @Accept json @Produce json @Param SubtaskData body models.ApiSubtaskData true "Subtask data" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/subtask/add [post]
func (*Handler) AddTask ¶
@Summary Create task @Tags Working with tasks @Accept json @Produce json @Param TaskData body models.ApiTaskData true "Task data" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/task/add [post]
func (*Handler) DeleteList ¶
@Summary Delete list @Tags Working with lists @Accept json @Produce json @Param list_id query int true "The id of the list to be deleted" @Success 200 {object} models.ApiMessage @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/list/delete [delete]
func (*Handler) DeleteSubtask ¶
@Summary Delete subtask @Tags Working with subtasks @Accept json @Produce json @Param subtask_id query int true "The id of the subtask to be deleted" @Success 200 {object} models.ApiMessage @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/subtask/delete [delete]
func (*Handler) DeleteTask ¶
@Summary Delete task @Tags Working with tasks @Accept json @Produce json @Param task_id query int true "The id of the task to be deleted" @Success 200 {object} models.ApiMessage @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/task/delete [delete]
func (*Handler) DeleteUser ¶
@Summary Delete user account @Tags User settings @Accept json @Produce json @Param password query string true "User password" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /user/delete/account [delete]
func (*Handler) DeleteUserIcon ¶
@Summary Delete user icon @Tags User settings @Accept json @Produce json @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /user/delete/icon [delete]
func (*Handler) EditList ¶
@Summary Edit list @Tags Working with lists @Accept json @Produce json @Param ListData body models.ListEditData true "List data" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/list/edit [put]
func (*Handler) EditSubtask ¶
@Summary Edit subtask @Tags Working with subtasks @Accept json @Produce json @Param SubtaskData body models.SubtaskEditData true "Subtask data" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/subtask/edit [put]
func (*Handler) EditTask ¶
@Summary Edit task @Tags Working with tasks @Accept json @Produce json @Param TaskData body models.TaskEditData true "Task data" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/task/edit [put]
func (*Handler) EditUserName ¶
@Summary Change user name @Tags User settings @Accept json @Produce json @Param NewUserName body models.UserName true "User name" @Success 200 {object} models.ApiMessage @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /user/settings/update/name [patch]
func (*Handler) EditUserUsername ¶
@Summary Change user username @Tags User settings @Accept json @Produce json @Param NewUsername body models.UserUsername true "Username" @Success 200 {object} models.ApiMessage @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /user/settings/update/username [patch]
func (*Handler) GetUserData ¶
@Summary Get basic user data @Tags Show user data @Accept json @Produce json @Param user_id query int true "User id" @Success 200 {object} models.ShowUserData @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Router /user/show/data-by-id [get]
func (*Handler) GetUserDataByToken ¶
@Summary Get basic user data @Tags Show user data @Accept json @Produce json @Success 200 {object} models.ShowUserData @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /user/show/data-by-token [get]
func (*Handler) GetUserIcon ¶
@Summary Get user icon @Tags Show user data @Accept json @Produce json @Param user_id query int true "User id" @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Router /user/show/icon [get]
func (*Handler) InitRoutes ¶
func (*Handler) ResetUserEmail ¶
@Summary Reset user email @Tags User settings @Accept json @Produce json @Param NewUserEmail body models.UserEmail true "New user email" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /user/settings/reset/email [post]
func (*Handler) ResetUserPassword ¶
@Summary Reset user password @Tags User settings @Accept json @Produce json @Param UserEmail body models.UserEmail true "User data" @Success 200 {object} models.UserTokens @Failure 400 {object} models.ApiError @Failure 500 {object} models.ApiError @Router /user/settings/reset/password [post]
func (*Handler) ShowLists ¶
@Summary Shows all lists created by the user @Tags Working with lists @Accept json @Produce json @Success 200 {object} models.ApiShowLists @Failure 404 {object} models.ApiError @Security token @Router /todo/list/show [get]
func (*Handler) ShowSubtasks ¶
@Summary Shows all subtasks in the task @Tags Working with subtasks @Accept json @Produce json @Param task_id query int true "Task id with subtasks" @Success 200 {object} models.ApiShowSubtasks @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/subtask/show [get]
func (*Handler) ShowTasks ¶
@Summary Shows all tasks in the list @Tags Working with tasks @Accept json @Produce json @Param list_id query int true "List id with tasks" @Success 200 {object} models.ApiShowTasks @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /todo/task/show [get]
func (*Handler) SignIn ¶
@Summary Sign in to your account @Tags Authorization @Accept json @Produce json @Param LoginData body models.UserLoginData true "User data" @Success 200 {object} models.UserTokens @Failure 400 {object} models.ApiError @Failure 500 {object} models.ApiError @Router /auth/sign-in [post]
func (*Handler) SignUp ¶
@Summary Register a user @Tags Authorization @Accept json @Produce json @Param UserData body models.UserData true "User data" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Router /auth/sign-up [post]
func (*Handler) UpdateUserEmail ¶
@Summary Update user email @Tags User settings @Accept json @Produce json @Param key query string true "Veryfication key" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 500 {object} models.ApiError @Router /user/settings/update/email [patch]
func (*Handler) UpdateUserIcon ¶
@Summary Update user icon @Tags User settings @Accept json @Produce json @Param icon formData file true "User icon" @Success 200 {object} models.ApiMessage @Failure 400 {object} models.ApiError @Failure 500 {object} models.ApiError @Security token @Router /user/settings/update/icon [put]
func (*Handler) UpdateUserPassword ¶
@Summary Update user password @Tags User settings @Accept json @Produce json @Param NewUserPassword body models.UserPassword true "User password" @Param key query string true "Veryfication key" @Success 200 {object} models.UserTokens @Failure 404 {object} models.ApiError @Failure 500 {object} models.ApiError @Router /user/settings/update/password [patch]
func (*Handler) UpdateUserToken ¶
@Summary Update user token @Tags User settings @Accept json @Produce json @Param refresh_token header string true "Refresh token" @Success 200 {object} models.UserTokens @Router /user/settings/update/token [put]
func (*Handler) VerifySignUp ¶
@Summary Confirm the new user's email @Tags Authorization @Accept json @Produce json @Param key query string true "Verification key" @Success 200 {object} models.UserTokens @Failure 400 {object} models.ApiError @Failure 500 {object} models.ApiError @Router /auth/verify [get]
Source Files