group

Documentation

Index

• Constants
• type Controller
  • func NewController(param *param.Param) Controller
• type Group
• type NewGroup
• type RegionSelector
• type RegionSelectors
• type SearchParams
• type StructuredGroup
• type UpdateGroup

Constants

const (
	// ErrCodeNotFound a kind of error code, returned when there's no group matching the given id
	ErrCodeNotFound = errors.ErrorCode("RecordNotFound")
	// ErrGroupHasChildren a kind of error code, returned when deleting a group which still has some children
	ErrGroupHasChildren = errors.ErrorCode("GroupHasChildren")
)

Types

type Controller

type Controller interface {
	// CreateGroup add a group
	CreateGroup(ctx context.Context, newGroup *NewGroup) (uint, error)
	// Delete remove a group by the id
	Delete(ctx context.Context, id uint) error
	// GetByID get a group by the id
	GetByID(ctx context.Context, id uint) (*StructuredGroup, error)
	// GetByFullPath get a group by the URLPath
	GetByFullPath(ctx context.Context, resourcePath string, resourceType string) (*service.Child, error)
	// Transfer put a group under another parent group
	Transfer(ctx context.Context, id, newParentID uint) error
	// UpdateBasic update basic info of a group, including name, path, description and visibilityLevel
	UpdateBasic(ctx context.Context, id uint, updateGroup *UpdateGroup) error
	// GetSubGroups get subgroups of a group
	GetSubGroups(ctx context.Context, id uint, pageNumber, pageSize int) ([]*service.Child, int64, error)
	// GetChildren get children of a group, including subgroups and applications
	GetChildren(ctx context.Context, id uint, pageNumber, pageSize int) ([]*service.Child, int64, error)
	// SearchGroups search subGroups of a group
	SearchGroups(ctx context.Context, params *SearchParams) ([]*service.Child, int64, error)
	// SearchChildren search children of a group, including subgroups and applications
	SearchChildren(ctx context.Context, params *SearchParams) ([]*service.Child, int64, error)
	// ListAuthedGroup get all the authed groups of current user(if is admin, return all the groups)
	ListAuthedGroup(ctx context.Context) ([]*Group, error)
	// UpdateRegionSelector update regionSelector
	UpdateRegionSelector(ctx context.Context, id uint, regionSelector RegionSelectors) error
}

func NewController

func NewController(param *param.Param) Controller

NewController initializes a new group controller

type Group

type Group struct {
	ID              uint      `json:"id"`
	Name            string    `json:"name"`
	Path            string    `json:"path"`
	VisibilityLevel string    `json:"visibilityLevel"`
	Description     string    `json:"description"`
	ParentID        uint      `json:"parentID"`
	TraversalIDs    string    `json:"traversalIDs"`
	UpdatedAt       time.Time `json:"updatedAt"`
	FullName        string    `json:"fullName"`
	FullPath        string    `json:"fullPath"`
}

Group basic info of group, including group & application

type NewGroup

type NewGroup struct {
	Name            string `json:"name" binding:"required"`
	Path            string `json:"path" binding:"required"`
	VisibilityLevel string `json:"visibilityLevel"`
	Description     string `json:"description"`
	ParentID        uint   `json:"parentID"`
}

NewGroup model for creating a group

type RegionSelector

type RegionSelector struct {
	Key      string   `json:"key"`
	Values   []string `json:"values"`
	Operator string   `json:"operator" default:"in"`
}

type RegionSelectors

type RegionSelectors []*RegionSelector

type SearchParams

type SearchParams struct {
	Filter     string
	GroupID    uint
	PageNumber int
	PageSize   int
}

SearchParams contains parameters for searching operation

type StructuredGroup

type StructuredGroup struct {
	*Group
	RegionSelectors RegionSelectors `json:"regionSelectors"`
}

type UpdateGroup

type UpdateGroup struct {
	Name            string `json:"name" binding:"required"`
	Path            string `json:"path" binding:"required"`
	VisibilityLevel string `json:"visibilityLevel"`
	Description     string `json:"description"`
}

UpdateGroup model for updating a group