Documentation
¶
Index ¶
- type Handler
- func (h *Handler) Delete(w http.ResponseWriter, r *http.Request)
- func (h *Handler) Invite(w http.ResponseWriter, r *http.Request)
- func (h *Handler) List(w http.ResponseWriter, r *http.Request)
- func (h *Handler) Read(w http.ResponseWriter, r *http.Request)
- func (h *Handler) ResendInvitationEmail(w http.ResponseWriter, r *http.Request)
- func (h *Handler) Update(w http.ResponseWriter, r *http.Request)
- type NewParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
func (*Handler) Delete ¶
func (h *Handler) Delete(w http.ResponseWriter, r *http.Request)
Delete godoc @Description Delete a user from the organization. @Param userID path int true "User ID" @Router /users/{userID} [delete] @Security UserAccessTokenAuthentication @Success 204 @Summary Delete user @Tags users
func (*Handler) Invite ¶
func (h *Handler) Invite(w http.ResponseWriter, r *http.Request)
Invite godoc @Description Invite a new user to organization. @Param params body poeticmetric.InviteOrganizationUserParams true "Params" @Router /users [post] @Security UserAccessTokenAuthentication @Success 200 {array} poeticmetric.OrganizationUser @Summary Invite user @Tags users
func (*Handler) List ¶
func (h *Handler) List(w http.ResponseWriter, r *http.Request)
List godoc @Description List users. @Router /users [get] @Security UserAccessTokenAuthentication @Success 200 {array} poeticmetric.OrganizationUser @Summary List users @Tags users
func (*Handler) Read ¶
func (h *Handler) Read(w http.ResponseWriter, r *http.Request)
Read godoc @Description Read a user from the organization. @Param userID path int true "User ID" @Router /users/{userID} [get] @Security UserAccessTokenAuthentication @Success 200 {array} poeticmetric.OrganizationUser @Summary Read user @Tags users
func (*Handler) ResendInvitationEmail ¶
func (h *Handler) ResendInvitationEmail(w http.ResponseWriter, r *http.Request)
ResendInvitationEmail godoc @Description Resend invitation e-mail to user. @Param params body poeticmetric.InviteOrganizationUserParams true "Params" @Router /users [post] @Security UserAccessTokenAuthentication @Success 202 {array} responder.DetailResponse @Summary Resend invitation e-mail @Tags users
func (*Handler) Update ¶
func (h *Handler) Update(w http.ResponseWriter, r *http.Request)
Update godoc @Description Update organization user. @Param userID path int true "User ID" @Param params body poeticmetric.UpdateOrganizationUserParams true "Params" @Router /users/{userID} [patch] @Security UserAccessTokenAuthentication @Success 200 {array} poeticmetric.OrganizationUser @Summary Update user @Tags users
type NewParams ¶
type NewParams struct {
UserService poeticmetric.UserService
Responder poeticmetric.RestApiResponder
}
Source Files