v1

package
v0.0.0-...-caf5947 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 8, 2020 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateChannel

func CreateChannel(c *gin.Context)

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]

func DeleteChannel

func DeleteChannel(c *gin.Context)

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

func GetChannel

func GetChannel(c *gin.Context)

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]

func GetChannels

func GetChannels(c *gin.Context)

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]

func GetUser

func GetUser(c *gin.Context)

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]

func GetUserPref

func GetUserPref(c *gin.Context)

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]

func GetUsers

func GetUsers(c *gin.Context)

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]

func UpdateChannel

func UpdateChannel(c *gin.Context)

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]

func UpdateUserPref

func UpdateUserPref(c *gin.Context)

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]

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址