Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddBarkAlertPostmanToUser ¶
@Summary Add BarkAlert postman to user @Tags User @Description send alert to user @Accept json @Produce json @Param id path string true "The user ID" @Param alertBody body model.BarkAlert true "The bark alert postman" @Success 200 {object} model.User "The user after add bark alert postman" @Failure 400 {object} utils.WebResponse "Bad request" @Failure 404 {object} utils.WebResponse "Not found" @Failure 500 {object} utils.WebResponse "Internal error" @Router /users/{id}/bark [post]
func GetUser ¶
@Summary Get user by ID @Tags User @Description get user by ID @Accept json @Produce json @Param id path string true "The user ID" @Success 200 {object} model.User "The user info" @Failure 400 {object} utils.WebResponse "Bad request" @Failure 404 {object} utils.WebResponse "Not found" @Failure 500 {object} utils.WebResponse "Internal error" @Router /users/{id} [get]
func GetUsers ¶
@Summary Get all users @Tags User @Description get all users @Accept json @Produce json @Success 200 {object} []model.User "All the user infos" @Failure 400 {object} utils.WebResponse "Bad request" @Failure 500 {object} utils.WebResponse "Internal error" @Router /users [get]
func Index ¶
Index ... @Summary Index @Tags index @Accept json @Produce json @Success 200 {string} string "Here is the neuron server" @Router / [get]
func NewUser ¶
@Summary Add a new user @Tags User @Description add a new user @Accept json @Produce json @Param body body model.UserInput true "The user input info" @Success 200 {object} model.User "The user info" @Failure 400 {object} utils.WebResponse "Bad request" @Failure 500 {object} utils.WebResponse "Internal error" @Router /users [post]
func SendAlertToUser ¶
@Summary Send alert to user @Tags User @Description send alert to user @Accept json @Produce json @Param id path string true "The user ID" @Param alertBody body model.AlertBody true "The alert body" @Success 200 {object} utils.WebResponse "Ok" @Failure 400 {object} utils.WebResponse "Bad request" @Failure 404 {object} utils.WebResponse "Not found" @Failure 500 {object} utils.WebResponse "Internal error" @Router /users/{id}/send [post]
Types ¶
This section is empty.
Source Files