Documentation ¶
Index ¶
- func CreateUniqueLink(length int) string
- func CreateUrl(c echo.Context) error
- func CreateUser(c echo.Context) error
- func DeleteUrl(c echo.Context) error
- func DeleteUser(c echo.Context) error
- func EnableSpecialUser(c echo.Context) error
- func FetchAuth(authD *auth.AccessDetails) (uint64, error)
- func ForgetPassword(c echo.Context) error
- func GetUrl(c echo.Context) error
- func GetUser(c echo.Context) error
- func Login(c echo.Context) error
- func Logout(c echo.Context) error
- func MyUrls(c echo.Context) error
- func Ping(c echo.Context) error
- func ResetPassword(c echo.Context) error
- func SendEmail(e auth.Email)
- func UpdateUser(c echo.Context) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateUniqueLink ¶
func CreateUrl ¶
func CreateUrl(c echo.Context) error
CreateUrl godoc @Summary create an short url @Description CreateUrl create a short url @Tags urls @Param source formData string true "source" @Accept json @Produce json @Success 200 {object} url.Url{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /urls/ [post]
func CreateUser ¶
func CreateUser(c echo.Context) error
CreateUser godoc @Summary create an user @Description create an user via username and password @Tags users @Param username formData string true "username" @Param password formData string true "password" @Accept json @Produce json @Success 200 {object} user.User{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /users/ [post]
func DeleteUrl ¶
func DeleteUrl(c echo.Context) error
DeleteUrl godoc @Summary delete an url @Description delete an url with @Tags urls @Accept json @Produce json @Success 200 {object} url.Url{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /urls/{url} [delete]
func DeleteUser ¶
func DeleteUser(c echo.Context) error
DeleteUser godoc @Summary delete an user @Description delete an user @Tags users @Accept json @Produce json @Success 200 {string} string "user successfully deleted" @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /users/{id} [delete]
func EnableSpecialUser ¶
func EnableSpecialUser(c echo.Context) error
EnableSpecialUser godoc @Summary enable premium @Description EnableSpecialUser enable some features for users like create shorter link @Tags users @Accept mpfd @Produce json @Success 200 {object} user.User{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /users/premium/ [get]
func ForgetPassword ¶
func ForgetPassword(c echo.Context) error
ForgetPassword godoc @Summary forget password @Description ForgetPassword send a token via sms or email @Tags users @Accept mpfd @Produce json @Param phone_number formData string false "phone_number" @Param email formData string false "email" @Success 200 {object} user.User{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /users/forget-password/ [post]
func GetUrl ¶
func GetUrl(c echo.Context) error
GetUrl godoc @Summary get url @Description GetUrl get the main url to redirect @Tags urls @Param url path string true "url" @Accept json @Produce json @Success 200 {object} url.Url{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /urls/{url} [get]
func GetUser ¶
func GetUser(c echo.Context) error
GetUser godoc @Summary Show an user @Description get string by ID @Tags users @Accept json @Produce json @Param id path int true "User ID" @Success 200 {object} user.User{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /users/{id} [get]
func Login ¶
func Login(c echo.Context) error
Login godoc @Summary login an user @Description login an user @Tags users @Param username formData string true "username" @Param password formData string true "password" @Accept mpfd @Produce json @Success 200 {object} user.User{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /users/login/ [post]
func Logout ¶
func Logout(c echo.Context) error
Logout godoc @Summary logout an user @Description logout an user @Tags users @Accept json @Produce json @Success 200 string string "user successfully logout" @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /users/logout/ [post]
func MyUrls ¶
func MyUrls(c echo.Context) error
Myurls godoc @Summary show list of urls @Description MyUrls return a list of user's urls @Tags urls @Accept json @Produce json @Success 200 {array} url.Url{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /urls/my-links [get]
func ResetPassword ¶
func ResetPassword(c echo.Context) error
ResetPassword godoc @Summary reset password @Description ResetPassword validate token that user click on it and send a new password @Tags users @Accept mpfd @Produce json @Success 200 {string} string "a new password created" @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /users/reset/ [get]
func UpdateUser ¶
func UpdateUser(c echo.Context) error
UpdateUser godoc @Summary update an user @Description update an user with PUT or PATCH method @Tags users @Param phone_number formData string false "phone_number" @Param password formData string false "password" @Param email formData string false "email" @Accept json @Produce json @Success 200 {object} user.User{} @Failure 400 {object} utils.RestErr{} @Failure 401 {object} utils.RestErr{} @Failure 404 {object} utils.RestErr{} @Failure 500 {object} utils.RestErr{} @Router /users/{id} [patch]
Types ¶
This section is empty.