package
0.0.0-20241024164738-7e0c8036e957
Repository: https://github.com/romanshkvolkov/test-api.git
Documentation: pkg.go.dev

# Functions

@Summary Change password @Description This endpoint will change the password of authenticated the user @tags Authentication @Produce json @Security BearerAuth @Param NewPassword body domain.ChangePassword true "New password" @Success 200 {object} domain.APIResponse "Operation information" @Failure 400 {object} string "Unhandled error (report it)" @Failure 500 {object} string "Server error (report it)" @Router /auth/change-password [put].
No description provided by the author
@Summary Just User Profile by token @Description Get user profile by token @tags Users @Produce json @Security BearerAuth @Success 200 {object} string "User profile" @Failure 400 {object} string "Unhandled error (report it)" @Failure 500 {object} string "Server error (report it)" @Router /users/profile [get].
@Summary Just Users Profiles List @Description Get users profiles list @tags Users @Produce json @Security BearerAuth @Success 200 {object} domain.UserProfiles "Users profiles" @Failure 400 {object} string "Unhandled error (report it)" @Failure 500 {object} string "Server error (report it)" @Router /users/profiles [get].
@Summary Change password with the OTP code @Description This endpoint will reset the password of the user with the OTP code @tags Authentication @Produce json @Param NewCredentials body domain.ResetForgottenPassword true "New credentials by OTP" @Success 200 {object} domain.APIResponse "Operation information" @Failure 400 {object} string "Unhandled error (report it)" @Failure 500 {object} string "Server error (report it)" @Router /auth/forgot-password/reset [patch].
@Summary Send an email with the OTP code @Description This endpoint will send an email with the OTP code @tags Authentication @Produce json @Param UserIdentity body domain.PasswordResetRequest true "Requires the username to identify the user" @Success 200 {object} domain.APIResponse "Return just a message" @Failure 401 {object} string "Unhandled error (report it)" @Failure 500 {object} string "Server error (report it)" @Router /auth/forgot-password [patch].
No description provided by the author
@Summary Just Sign In @Description Sign in to the application @tags Authentication @Produce json @Param UserCredentials body domain.SignInRequest true "User credentials" @Success 200 {object} domain.APIResponse "Successful sign in" @Failure 400 {object} string "Unhandled error (report it)" @Failure 500 {object} string "Server error (report it)" @Router /auth/sign-in [post].
@Summary Just Sign Up @tags Authentication @Produce json @Param UserData body domain.NewUser true "Just the user data" @Success 200 {object} domain.APIResponse "Return message" @Failure 400 {object} string "Unhandled error (report it)" @Failure 500 {object} string "Server error (report it)" @Router /auth/sign-up [post].
@Summary Test email sending @Description This endpoint send a test email @tags Mail @Produce json @Security none @Success 200 {object} domain.APIResponse "Operation information" @Failure 400 {object} string "Unhandled error (report it)" @Failure 500 {object} string "Server error (report it)" @Router /mail/test [post].
No description provided by the author
@Summary Verify the code is valid @Description Returns data about the code @tags Authentication @Produce json @Param UserIdentity body domain.ForgottenPasswordCode true "Require the username and the OTP code" @Success 200 {object} domain.APIResponse "Information about the code" @Failure 400 {object} string "Unhandled error (report it)" @Failure 500 {object} string "Server error (report it)" @Router /auth/forgot-password/verify [post].

# Variables

No description provided by the author