package
0.0.0-20200708040304-caf59479c072
Repository: https://github.com/ducalixte/medichat-users.git
Documentation: pkg.go.dev
# Functions
CreateChannel godoc @Summary Create channel @Description create a new channel @Tags channels @Accept json @Produce json parameters: - in: body required: true schema: $ref: "#/definitions/createChannelRequest" @Success 200 {object} models.Channel @Header 200 {object} Token "qwerty" @Router /api/v1/channels [post].
DeleteChannel godoc @Summary Delete a channel @Description Delete by channel ID @Tags channels @Accept json @Produce json @Param id path int true "Channel ID" Format(int64) @Success 204 {object} models.Channel.
GetChannel godoc @Summary Show information on specific channel @Description get string by ID @ID get-string-by-int @Accept json @Produce json @Param id path int true "Channel ID" @Success 200 {object} models.Channel @Header 200 {string} Token "qwerty" @Router /api/v1/channels/{id} [get].
GetChannels godoc @Summary List channels @Description get channels @Accept json @Produce json @Param q query string false "name search by q" @Success 200 {array} models.Channel @Header 200 {string} Token "qwerty" @Router /api/v1/channels [get].
GetUser godoc @Summary Show information on specific user @Description provides user information with preferences in models.UserPref and channels from models.Channel @ID get-string-by-int @Accept json @Produce json @Param id path int true "User ID" @Success 200 {object} models.User @Header 200 {string} Token "qwerty" @Router /api/v1/users/{id} [get].
GetUserPref godoc @Summary Show information on specific user profile @Description provides user profile @ID get-string-by-int @Accept json @Produce json @Param id path int true "UserPref ID" @Success 200 {object} models.UserPref @Header 200 {string} Token "qwerty" @Router /api/v1/userPrefs/{id} [get].
GetUsers godoc @Summary List all Users @Description get all users @Accept json @Produce json @Param q query string false "name search by q" @Success 200 {array} models.User @Header 200 {string} Token "qwerty" @Router /api/v1/users [get].
UpdateChannel godoc @Summary Update an channel @Description Update by json channel @Tags channels @Accept json @Produce json @Param id path int true "Channel ID" parameters: - in: body required: true schema: $ref: "#/definitions/UpdateChannelRequest" @Success 200 {object} models.Channel @Router /api/v1/channels/{id} [put].
UpdateUserPref godoc @Summary Update an userPref @Description Update by json userPref @Tags userPrefs @Accept json @Produce json @Param id path int true "UserPref ID" parameters: - in: body required: true schema: $ref: "#/definitions/UpdateUserPrefRequest" @Success 200 {object} models.UserPref @Router /api/v1/userPrefs/{id} [put].