people

Documentation

Index

• type Repo
  • func NewRepo(db *sqlx.DB) *Repo
  • func (r *Repo) ListAllPeople(c echo.Context) error
  • func (r *Repo) ListRoleMembers(c echo.Context) error
  • func (r *Repo) UserByID(c echo.Context) error
  • func (r *Repo) UserByIDFull(c echo.Context) error
  • func (r *Repo) UserByToken(c echo.Context) error
  • func (r *Repo) UserByTokenFull(c echo.Context) error

Types

type Repo

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

Repo stores our dependencies

func NewRepo

func NewRepo(db *sqlx.DB) *Repo

NewRepo creates our data store

func (*Repo) ListAllPeople

func (r *Repo) ListAllPeople(c echo.Context) error

ListAllPeople handles listing all users

@Summary List all users @ID get-people-users-all @Tags people-users @Produce json @Success 200 {array} misc.List @Router /v1/internal/people/users [get]

func (*Repo) ListRoleMembers

func (r *Repo) ListRoleMembers(c echo.Context) error

ListRoleMembers handles listing all members of a certain role

@Summary List all users of a given role @ID get-people-users-roles-members @Tags people-users @Produce json @Param roleid path int true "Role ID" @Success 200 {array} misc.List @Router /v1/internal/people/users/{roleid} [get]

func (*Repo) UserByID

func (r *Repo) UserByID(c echo.Context) error

UserByID finds a user by ID @Summary Get a user by ID @Description Get a basic user object by ID. @ID get-user-id @Tags people-user @Produce json @Param userid path int true "User ID" @Success 200 {object} people.User @Router /v1/internal/people/user/{userid} [get]

func (*Repo) UserByIDFull

func (r *Repo) UserByIDFull(c echo.Context) error

UserByIDFull finds a user by ID returing all info @Summary Get a full user by ID @Description Get a complete user object by ID. @ID get-user-id-full @Tags people-user @Produce json @Param userid path int true "User ID" @Success 200 {object} people.User @Router /v1/internal/people/user/{userid}/full [get]

func (*Repo) UserByToken

func (r *Repo) UserByToken(c echo.Context) error

UserByToken finds a user by their JWT token @Summary Get a user by token @Description Get a basic user object by JWT token generated by web-auth. @ID get-user-token @Tags people-user @Produce json @Success 200 {object} people.User @Router /v1/internal/people/user [get]

func (*Repo) UserByTokenFull

func (r *Repo) UserByTokenFull(c echo.Context) error

UserByTokenFull finds a user by their JWT token returning all info @Summary Get a full user by token @Description Get a complete user object by JWT token generated by web-auth. @ID get-user-token-full @Tags people-user @Produce json @Success 200 {object} people.UserFull @Router /v1/internal/people/user/full [get]