Documentation
¶
Index ¶
- func NewAuthHandler(g *echo.Group, middManager *middlewares.MiddlewareManager, ...)
- func NewOrgHandler(g *echo.Group, middManager *middlewares.MiddlewareManager, ...)
- func NewUserHandler(g *echo.Group, middManager *middlewares.MiddlewareManager, ...)
- type AuthHandler
- type OrgHandler
- func (h *OrgHandler) Create(c echo.Context) wrapper.Response
- func (h *OrgHandler) Delete(c echo.Context) wrapper.Response
- func (h *OrgHandler) Fetch(c echo.Context) wrapper.Response
- func (h *OrgHandler) GetByID(c echo.Context) wrapper.Response
- func (h *OrgHandler) Invite(c echo.Context) wrapper.Response
- func (h *OrgHandler) Update(c echo.Context) wrapper.Response
- type UserHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewAuthHandler ¶ added in v0.3.0
func NewAuthHandler(g *echo.Group, middManager *middlewares.MiddlewareManager, userUsecase usecases.UserUsecase, appCfgs *config.AppConfig)
func NewOrgHandler ¶
func NewOrgHandler(g *echo.Group, middManager *middlewares.MiddlewareManager, orgUsecase usecases.OrgUsecase)
NewOrgHandler will initialize the org resources endpoint
func NewUserHandler ¶
func NewUserHandler(g *echo.Group, middManager *middlewares.MiddlewareManager, userUsecase usecases.UserUsecase)
NewUserHandler will initialize the user resources endpoint
Types ¶
type AuthHandler ¶ added in v0.3.0
type AuthHandler struct {
UserUC usecases.UserUsecase
Configs *config.AppConfig
}
func (*AuthHandler) LoginForm ¶ added in v0.3.0
func (h *AuthHandler) LoginForm(c echo.Context) error
LoginForm godoc @Summary Show login form @Description Renders Firebase login UI @Tags auth @Produce html @Success 200 {string} string "HTML login page" @Router /auth/login [get]
func (*AuthHandler) LoginSuccess ¶ added in v0.3.0
func (h *AuthHandler) LoginSuccess(c echo.Context) error
LoginSuccess godoc @Summary Show login success @Description Renders Firebase login success UI @Tags auth @Produce html @Success 200 {string} string "HTML success page" @Router /auth/success [get]
type OrgHandler ¶
type OrgHandler struct {
OrgUC usecases.OrgUsecase
}
func (*OrgHandler) Create ¶
func (h *OrgHandler) Create(c echo.Context) wrapper.Response
CreateNewOrg godoc @Summary Create a new org @Description Create a new organization @Tags orgs @Accept json @Produce json @Param body body dto.CreateOrgReq true "Organization creation request" @Success 201 {object} wrapper.SuccessResponse{data=domains.Org} @Failure 400 {object} wrapper.FailResponse @Failure 500 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /admin/orgs [post]
func (*OrgHandler) Delete ¶
func (h *OrgHandler) Delete(c echo.Context) wrapper.Response
DeleteOrg godoc @Summary Delete org @Description Delete organization by ID @Tags orgs @Accept json @Produce json @Param orgId path int true "Org ID" @Success 200 {object} wrapper.SuccessResponse{} @Failure 400 {object} wrapper.FailResponse @Failure 401 {object} wrapper.FailResponse @Failure 403 {object} wrapper.FailResponse @Failure 404 {object} wrapper.FailResponse @Failure 500 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /admin/orgs/{orgId} [delete]
func (*OrgHandler) Fetch ¶
func (h *OrgHandler) Fetch(c echo.Context) wrapper.Response
GetListOrgsOfCurrentUser godoc @Summary Get list org @Description Get list of organizations for current user @Tags orgs @Accept json @Produce json @Param limit query int false "Number of records should be returned" @Param page query int false "Page" @Success 200 {object} wrapper.SuccessResponse{data=[]domains.Org} @Failure 400 {object} wrapper.FailResponse @Failure 401 {object} wrapper.FailResponse @Failure 403 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /admin/orgs [get]
func (*OrgHandler) GetByID ¶
func (h *OrgHandler) GetByID(c echo.Context) wrapper.Response
GetOrgInfo godoc @Summary Get org info @Description Get org info by ID @Tags orgs @Accept json @Produce json @Param orgId path int true "Org ID" @Success 200 {object} wrapper.SuccessResponse{data=domains.Org} @Failure 401 {object} wrapper.FailResponse @Failure 403 {object} wrapper.FailResponse @Failure 404 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /admin/orgs/{orgId} [get]
func (*OrgHandler) Invite ¶
func (h *OrgHandler) Invite(c echo.Context) wrapper.Response
InviteUsers godoc @Summary Invite users to org @Description Send invitation emails to users to join organization @Tags orgs @Accept json @Produce json @Param orgId path int true "Org ID" @Param body body dto.InviteUsers true "Invitation request" @Success 200 {object} wrapper.SuccessResponse{} @Failure 400 {object} wrapper.FailResponse @Failure 401 {object} wrapper.FailResponse @Failure 403 {object} wrapper.FailResponse @Failure 404 {object} wrapper.FailResponse @Failure 500 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /admin/orgs/{orgId}/invites [post]
func (*OrgHandler) Update ¶
func (h *OrgHandler) Update(c echo.Context) wrapper.Response
UpdateOrgInfo godoc @Summary Update org info @Description Update organization by ID @Tags orgs @Accept json @Produce json @Param orgId path int true "Org ID" @Param body body dto.UpdateOrgReq true "Organization update request" @Success 200 {object} wrapper.SuccessResponse{} @Failure 400 {object} wrapper.FailResponse @Failure 401 {object} wrapper.FailResponse @Failure 403 {object} wrapper.FailResponse @Failure 404 {object} wrapper.FailResponse @Failure 500 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /admin/orgs/{orgId} [put]
type UserHandler ¶
type UserHandler struct {
UserUC usecases.UserUsecase
}
func (*UserHandler) Fetch ¶
func (h *UserHandler) Fetch(c echo.Context) wrapper.Response
GetListUser godoc @Summary Get list user info @Description Get list user info @Tags users @Accept json @Produce json @Param limit query int false "Number of records should be returned" @Param page query int false "Page" @Success 200 {object} wrapper.SuccessResponse{data=[]domains.User} @Failure 400 {object} wrapper.FailResponse @Failure 401 {object} wrapper.FailResponse @Failure 403 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /admin/users [get]
func (*UserHandler) GetByID ¶
func (h *UserHandler) GetByID(c echo.Context) wrapper.Response
GetUserInfo godoc @Summary Get user info @Description Get user info by ID @Tags users @Accept json @Produce json @Param userId path int true "User ID" @Success 200 {object} wrapper.SuccessResponse{data=domains.User} @Failure 400 {object} wrapper.FailResponse @Failure 401 {object} wrapper.FailResponse @Failure 403 {object} wrapper.FailResponse @Failure 404 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /admin/users/{userId} [get]
func (*UserHandler) GetCurrentUserInfo ¶ added in v0.3.0
func (h *UserHandler) GetCurrentUserInfo(c echo.Context) wrapper.Response
GetCurrentUserInfo godoc @Summary Get current user info @Description Get current authenticated user info @Tags auth @Accept json @Produce json @Success 200 {object} wrapper.SuccessResponse{data=domains.User} @Failure 401 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /me [get]
func (*UserHandler) UpdateCurrentUserInfo ¶ added in v0.4.0
func (h *UserHandler) UpdateCurrentUserInfo(c echo.Context) wrapper.Response
UpdateCurrentUserInfo godoc @Summary Update current user info @Description Update current authenticated user info @Tags auth @Accept json @Produce json @Success 200 {object} wrapper.SuccessResponse{data=domains.User} @Failure 400 {object} wrapper.FailResponse @Failure 401 {object} wrapper.FailResponse @Failure 403 {object} wrapper.FailResponse @Security XFirebaseBearer @Router /me [put]
Source Files
Directories