plugininfo

Documentation

Index

• func Get(c *gin.Context)
• func GetPluginMetas(c *gin.Context)
• type PluginInfo
  • func NewPluginInfo() *PluginInfo
• type PluginMeta
• type PluginMetas
• type PluginMetric
• type SubTaskMeta
  • func CreateSubTaskMeta(subTaskMeta []plugin.SubTaskMeta) []SubTaskMeta
• type TableInfo
• type TableInfos
  • func NewTableInfos(table dal.Tabler) *TableInfos
• type TotalInfo
  • func NewTotalInfo() *TotalInfo

Functions

func Get

func Get(c *gin.Context)

@Get detail info of plugins @Description GET /plugininfo @Description RETURN SAMPLE @Tags framework/plugininfo @Success 200 @Failure 400 {string} errcode.Error "Bad Request" @Router /plugininfo [get]

func GetPluginMetas

func GetPluginMetas(c *gin.Context)

@Get name list of plugins @Description GET /plugins @Description RETURN SAMPLE @Tags framework/plugins @Success 200 {object} PluginMetas @Failure 400 {string} errcode.Error "Bad Request" @Router /plugins [get]

Types

type PluginInfo

type PluginInfo struct {
	Name        string        `json:"name"`
	Description string        `json:"description"`
	Tables      []*TableInfos `json:"tables"`
	TaskMeta    []SubTaskMeta `json:"task_mata"`
}

func NewPluginInfo

func NewPluginInfo() *PluginInfo

type PluginMeta

type PluginMeta struct {
	Plugin string       `json:"plugin"`
	Metric PluginMetric `json:"metric"`
}

type PluginMetas

type PluginMetas []PluginMeta

type PluginMetric

type PluginMetric struct {
	RequiredDataEntities []map[string]interface{} `json:"requiredDataEntities"`
	RunAfter             []string                 `json:"runAfter"`
	IsProjectMetric      bool                     `json:"isProjectMetric"`
}

type SubTaskMeta

type SubTaskMeta struct {
	Name             string   `json:"name"`
	Required         bool     `json:"required"`
	EnabledByDefault bool     `json:"enabled_by_default"`
	Description      string   `json:"description"`
	DomainTypes      []string `json:"domain_types"`
}

func CreateSubTaskMeta

func CreateSubTaskMeta(subTaskMeta []plugin.SubTaskMeta) []SubTaskMeta

type TableInfo

type TableInfo struct {
	Name         string `json:"name"`
	Tags         string `json:"tags"`
	DbName       string `json:"db_name"`
	DataType     string `json:"data_type"`
	GORMDataType string `json:"gorm_data_type"`
}

type TableInfos

type TableInfos struct {
	TableName string       `json:"table_name"`
	Field     []*TableInfo `json:"field"`
	Error     *string      `json:"error"`
}

func NewTableInfos

func NewTableInfos(table dal.Tabler) *TableInfos

type TotalInfo

type TotalInfo struct {
	DomainInfos []*TableInfos
	PluginInfos []*PluginInfo
}

func NewTotalInfo

func NewTotalInfo() *TotalInfo