Documentation
¶
Overview ¶
Package controllers Auth controllers
Index ¶
- Constants
- func AddFollower(c *fiber.Ctx) error
- func AddFriend(c *fiber.Ctx) error
- func Delete(c *fiber.Ctx) error
- func DeleteFollower(c *fiber.Ctx) error
- func DeleteFriend(c *fiber.Ctx) error
- func DeletePheme(c *fiber.Ctx) error
- func GetAllPhemes(c *fiber.Ctx) error
- func GetFollowers(c *fiber.Ctx) error
- func GetFollowings(c *fiber.Ctx) error
- func GetFriends(c *fiber.Ctx) error
- func GetMyPhemes(c *fiber.Ctx) error
- func GetPheme(c *fiber.Ctx) error
- func GetUserByID(c *fiber.Ctx) error
- func GetUserPhemes(c *fiber.Ctx) error
- func GetUsers(c *fiber.Ctx) error
- func GetUsersByName(c *fiber.Ctx) error
- func Login(c *fiber.Ctx) error
- func Logout(c *fiber.Ctx) error
- func PostPheme(c *fiber.Ctx) error
- func Register(c *fiber.Ctx) error
- func UpdatePheme(c *fiber.Ctx) error
- func User(c *fiber.Ctx) error
Constants ¶
const SecretKey = "secret"
SecretKey the secret key.
Variables ¶
This section is empty.
Functions ¶
func AddFollower ¶
func AddFollower(c *fiber.Ctx) error
AddFollower godoc @Summary Add a follower to the user @Description put a follower to the user @Tags user @Accept json @Produce json @Param id path string true "Follower ID" @Success 200 {object} models.Message @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/follower/{id} [put]
func AddFriend ¶
func AddFriend(c *fiber.Ctx) error
AddFriend godoc @Summary Add a friends to the user @Description put a friend to the user @Tags user @Accept json @Produce json @Param id path string true "Friend ID" @Success 200 {object} models.Message @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/friend/{id} [put]
func Delete ¶
func Delete(c *fiber.Ctx) error
Delete godoc @Summary Delete the user @Description delete the user @Tags authentication @Produce json @Success 200 {object} models.Message @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user [delete]
func DeleteFollower ¶
func DeleteFollower(c *fiber.Ctx) error
DeleteFollower godoc @Summary Delete a follower of the user @Description Delete a follower of the user @Tags user @Accept json @Produce json @Param id path string true "Follower ID" @Success 200 {object} models.Message @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/follower/{id} [delete]
func DeleteFriend ¶
func DeleteFriend(c *fiber.Ctx) error
DeleteFriend godoc @Summary Delete a friend of the user @Description delete a friend of the user @Tags user @Accept json @Produce json @Param id path string true "Friend ID" @Success 200 {object} models.Message @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/friend/{id} [delete]
func DeletePheme ¶
func DeletePheme(c *fiber.Ctx) error
DeletePheme godoc @Summary Delete a pheme from the user @Description delete a user pheme @Tags phemes @Produce json @Param id path int true "Pheme ID" @Success 200 {object} models.PhemeParamsID @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /pheme/{id} [delete]
func GetAllPhemes ¶
func GetAllPhemes(c *fiber.Ctx) error
GetAllPhemes godoc @Summary Retrieve all phemes @Description get all phemes @Tags phemes @Produce json @Success 200 {object} []models.Pheme @Failure 401 {object} models.Message @Router /pheme [get]
func GetFollowers ¶
func GetFollowers(c *fiber.Ctx) error
GetFollowers godoc @Summary Retrieve the user followers @Description get the user followers @Tags user @Accept json @Produce json @Param name path id true "User ID" @Success 200 {object} models.User @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/followers/{id} [get]
func GetFollowings ¶
func GetFollowings(c *fiber.Ctx) error
GetFollowings godoc @Summary Retrieve the following users @Description get the following users @Tags user @Accept json @Produce json @Param name path id true "User ID" @Success 200 {object} models.User @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/following/{id} [get]
func GetFriends ¶
func GetFriends(c *fiber.Ctx) error
GetFriends godoc @Summary Retrieve the user friends @Description get the user friends @Tags user @Accept json @Produce json @Success 200 {object} models.User @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/friends [get]
func GetMyPhemes ¶
func GetMyPhemes(c *fiber.Ctx) error
GetMyPhemes godoc @Summary Retrieve the user phemes @Description get the user phemes @Tags phemes @Produce json @Success 200 {object} []models.Pheme @Failure 401 {object} models.Message @Router /pheme/mine [get]
func GetPheme ¶
func GetPheme(c *fiber.Ctx) error
GetPheme godoc @Summary Retrieve the pheme @Description get the pheme @Tags phemes @Produce json @Param id path int true "Pheme ID" @Success 200 {object} models.Pheme @Failure 204 {object} models.Message @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /pheme/{id} [get]
func GetUserByID ¶
func GetUserByID(c *fiber.Ctx) error
GetUserByID godoc @Summary Retrieve the user by ID @Description get the user @Tags user @Accept json @Produce json @Param name path id true "User ID" @Success 200 {object} models.UserPublicData @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/{id} [get]
func GetUserPhemes ¶
func GetUserPhemes(c *fiber.Ctx) error
GetUserPhemes godoc @Summary Retrieve the user phemes @Description get the user phemes @Tags phemes @Produce json @Param id path int true "User ID" @Success 200 {object} []models.Pheme @Failure 401 {object} models.Message @Router /pheme/user/{id} [get]
func GetUsers ¶
func GetUsers(c *fiber.Ctx) error
GetUsers godoc @Summary Retrieve the users @Description get the users @Tags user @Accept json @Produce json @Success 200 {object} []models.UserPublicData @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/{id} [get]
func GetUsersByName ¶
func GetUsersByName(c *fiber.Ctx) error
GetUsersByName godoc @Summary Retrieve the users by name @Description get the users @Tags user @Accept json @Produce json @Param name path string true "User name" @Success 200 {object} []models.User @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /user/{name} [get]
func Login ¶
func Login(c *fiber.Ctx) error
Login godoc @Summary Login to a user @Description user login @Tags authentication @Accept json @Produce json @Success 200 {object} models.Message @Failure 404 {object} models.Message @Failure 400 {object} models.Message @Failure 500 {object} models.Message @Router /login [post]
func Logout ¶
func Logout(c *fiber.Ctx) error
Logout godoc @Summary Logout the user @Description logout and remove the user cookie @Tags authentication @Produce json @Success 200 {object} models.Message @Router /logout [post]
func PostPheme ¶
func PostPheme(c *fiber.Ctx) error
PostPheme godoc @Summary Post a pheme to the user @Description post a user pheme @Tags phemes @Accept json @Produce json @Success 200 {object} models.PhemeParamsID @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /pheme [post]
func Register ¶
func Register(c *fiber.Ctx) error
Register godoc @Summary Register a user @Description add a user @Tags authentication @Accept json @Produce json @Success 200 {object} models.User @Failure 400 {object} models.Message @Router /register [post]
func UpdatePheme ¶
func UpdatePheme(c *fiber.Ctx) error
UpdatePheme godoc @Summary Update a pheme to the user @Description update a user pheme @Tags phemes @Accept json @Produce json @Param id path int true "Pheme ID" @Success 200 {object} models.Pheme @Failure 400 {object} models.Message @Failure 401 {object} models.Message @Router /pheme/{id} [put]
Types ¶
This section is empty.
Source Files