v1

Documentation

Index

• type V1
  • func New(options *options.Options, logger *zerolog.Logger) *V1
  • func (v *V1) App() *fiber.App
  • func (v *V1) Health(ctx *fiber.Ctx) error
  • func (v *V1) Logout(ctx *fiber.Ctx) error
  • func (v *V1) UserInfo(ctx *fiber.Ctx) error

Types

type V1

type V1 struct {
	// contains filtered or unexported fields
}

func New

func New(options *options.Options, logger *zerolog.Logger) *V1

func (*V1) App

func (v *V1) App() *fiber.App

func (*V1) Health

func (v *V1) Health(ctx *fiber.Ctx) error

Health godoc @Summary Health returns the status of the various services @Description Health returns the status of the various services @Tags health @Accept json @Produce json @Success 200 {object} models.HealthResponse @Failure 500 {string} string @Router /health [get]

func (*V1) Logout

func (v *V1) Logout(ctx *fiber.Ctx) error

Logout godoc @Summary Logout logs out a user @Description Logout logs out a user @Tags logout @Accept json @Produce json @Success 200 {string} string @Failure 400 {string} string @Failure 401 {string} string @Failure 500 {string} string @Router /logout [post]

func (*V1) UserInfo

func (v *V1) UserInfo(ctx *fiber.Ctx) error

UserInfo godoc @Summary UserInfo checks if a user is logged in and returns their info @Description UserInfo checks if a user is logged in and returns their info @Tags userinfo @Accept json @Produce json @Success 200 {object} models.UserInfoResponse @Failure 400 {string} string @Failure 401 {string} string @Failure 500 {string} string @Router /userinfo [post]