package
0.0.0-20241007120623-b946689a3c72
Repository: https://github.com/znotify/server.git
Documentation: pkg.go.dev
# Functions
Check godoc
@Summary Check if the user secret is valid @Id checkUserSecret @Tags User @Produce json @Param user_secret query string true "Secret of user" @Success 200 {object} common.Response[bool] @Router /check [get].
Devices
@Summary Get user devices @Id getDevicesByUserSecret @Tags User @Description Delete device with device_id @Param user_secret path string true "Secret of user" @Produce json @Success 200 {object} common.Response[[]models.Device] @Router /{user_secret}/devices [get].
GitHub
@Summary OAuth callback for GitHub, redirect to ui with user_secret @Id githubOAuthCallback @Tags User @Success 307 @Router /login/github [get] @Param state query string false "should always be 'no_need_to_set_state'" @Param code query string true "access code" @Failure 400 {object} common.BadRequestResponse @Failure 401 {object} common.UnauthorizedResponse.
Login
@Summary Login with GitHub @Id userLogin @Tags User @Success 307 @Router /login [get].
Messages godoc
@Summary Get messages of user @Id getMessagesByUserSecret @Tags User @Description Get messages of user with pagination @Param user_secret path string true "Secret of user" @Param skip query int false "The number of records to skip" default(0) minimum(0) @Param limit query int false "The number of records to return" default(20) maximum(100) minimum(0) @Produce json @Success 200 {object} common.Response[[]models.Message] @Failure 401 {object} common.UnauthorizedResponse @Router /{user_secret}/messages [get].