Documentation
¶
Index ¶
- func HandleAdminCreateRunner(c *gin.Context)
- func HandleAdminCreateUser(c *gin.Context)
- func HandleAdminDeleteRunner(c *gin.Context)
- func HandleAdminDeleteUser(c *gin.Context)
- func HandleAdminImpersonateUser(c *gin.Context)
- func HandleAdminListImpersonationLogsByUser(c *gin.Context)
- func HandleAdminListRunners(c *gin.Context)
- func HandleAdminListUsers(c *gin.Context)
- func HandleAdminRetrieveRunners(c *gin.Context)
- func HandleAdminRetrieveUser(c *gin.Context)
- func HandleAdminSetUserPassword(c *gin.Context)
- func HandleAdminStats(c *gin.Context)
- func HandleAdminUpdateRunner(c *gin.Context)
- func HandleAdminUpdateUser(c *gin.Context)
- type AdminCreateUserRequestBody
- type AdminSetUserPasswordRequestBody
- type AdminUpdateRunnerRequestBody
- type AdminUpdateUserRequestBody
- type HandleAdminCreateRunnerRequestBody
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HandleAdminCreateRunner ¶
HandleAdminCreateRunner godoc @Summary Create a runner @Schemes @Description Create a runner @Tags Admin @Accept json @Produce json @Success 201 @Param request body HandleAdminCreateRunnerRequestBody true "Runner details" @Router /api/v1/admin/runners [post]
func HandleAdminCreateUser ¶
HandleAdminCreateUser godoc @Summary Admin Create User @Schemes @Description Admin Create User @Tags Admin @Accept json @Produce json @Param request body AdminCreateUserRequestBody true "User info" @Success 200 {object} serializers.AdminUserSerializer @Router /api/v1/admin/users [post]
func HandleAdminDeleteRunner ¶
HandleAdminDeleteRunner godoc @Summary Delete a runner @Schemes @Description Delete a runner @Tags Admin @Accept json @Produce json @Success 204 @Router /api/v1/admin/runners/:id [delete]
func HandleAdminDeleteUser ¶
HandleAdminDeleteUser godoc @Summary Admin delete user @Schemes @Description Admin delete user @Tags Admin @Accept json @Produce json @Success 204 @Router /api/v1/admin/users/{email} [delete]
func HandleAdminImpersonateUser ¶
HandleAdminImpersonateUser godoc @Summary API for admins to impersonate a user @Schemes @Description API for admins to impersonate a user @Tags Admin @Accept json @Produce json @Success 200 @Router /api/v1/admin/users/{email}/impersonate [post]
func HandleAdminListImpersonationLogsByUser ¶
HandleAdminListImpersonationLogsByUser godoc @Summary API for admins to list impersonation logs for a user @Schemes @Description API for admins to list impersonation logs for a user @Tags Admin @Accept json @Produce json @Success 200 @Router /api/v1/admin/users/{email}/impersonation-logs [get]
func HandleAdminListRunners ¶
AdminRunners godoc @Summary List all available runners @Schemes @Description List all available runners @Tags Admin @Accept json @Produce json @Success 200 {object} []serializers.AdminRunnersSerializer @Router /api/v1/admin/runners [get]
func HandleAdminListUsers ¶
HandleAdminListUsers godoc @Summary Admin List Users @Schemes @Description List all users ordered by creation date descending @Tags Admin @Accept json @Produce json @Success 200 {object} []serializers.AdminUserSerializer @Router /api/v1/admin/users [get]
func HandleAdminRetrieveRunners ¶
HandleAdminRetrieveRunners godoc @Summary Retrive a runner by its id @Schemes @Description Retrive a runner by its id @Tags Admin @Accept json @Produce json @Success 200 {object} serializers.AdminRunnersSerializer @Router /api/v1/admin/runners/:id [get]
func HandleAdminRetrieveUser ¶
HandleAdminRetrieveUser godoc @Summary Admin Retrieve User @Schemes @Description Admin Retrieve User @Tags Admin @Accept json @Produce json @Success 200 {object} serializers.AdminUserSerializer @Router /api/v1/admin/users/{email} [get]
func HandleAdminSetUserPassword ¶
AdminSetUserPassword godoc @Summary Admin update user password @Schemes @Description Admin update user password @Tags Admin @Accept json @Produce json @Param request body AdminSetUserPasswordRequestBody true "User info" @Success 200 @Router /api/v1/admin/users/{email}/set-password [post]
func HandleAdminStats ¶
AdminStats godoc @Summary Admin Stats @Schemes @Description Admin Stats @Tags Admin @Accept json @Produce json @Success 200 {object} serializers.AdminStatsSerializer @Router /api/v1/admin/stats [get]
func HandleAdminUpdateRunner ¶
HandleAdminCreateRunner godoc @Summary Create a runner @Schemes @Description Create a runner @Tags Admin @Accept json @Produce json @Success 200 {object} serializers.AdminRunnersSerializer @Param request body AdminUpdateRunnerRequestBody true "Runner details" @Router /api/v1/admin/runners/:id [put]
func HandleAdminUpdateUser ¶
HandleAdminUpdateUser godoc @Summary Admin update user @Schemes @Description Admin update user @Tags Admin @Accept json @Produce json @Param request body AdminUpdateUserRequestBody true "User info" @Success 200 {object} serializers.AdminUserSerializer @Router /api/v1/admin/users/{email} [put]
Types ¶
type AdminCreateUserRequestBody ¶
type AdminCreateUserRequestBody struct {
Email string `json:"email" binding:"required,email"`
Password string `json:"password" binding:"required"`
FirstName string `json:"first_name" binding:"required"`
LastName string `json:"last_name" binding:"required"`
IsSuperuser bool `json:"is_superuser"`
IsTemplateManager bool `json:"is_template_manager"`
}
type AdminSetUserPasswordRequestBody ¶
type AdminSetUserPasswordRequestBody struct {
Password string `json:"password" binding:"required"`
}
Source Files