api

Documentation

Index

• Constants
• func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• func Init(config *viper.Viper, logger core.Logger, database *gorm.DB)
• func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• func Proxy(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• type StatusMappings
• type TapdBlueprintSetting
• type TapdPipelinePlan
• type TransformationRules
• type TypeMapping
• type TypeMappings

Constants

const (
	TimeOut = 10 * time.Second
)

Functions

func DeleteConnection

func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary delete a tapd connection @Description Delete a Tapd connection @Tags plugins/tapd @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections/{connectionId} [DELETE]

func GetConnection

func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary get tapd connection detail @Description Get Tapd connection detail @Tags plugins/tapd @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections/{connectionId} [GET]

func Init

func Init(config *viper.Viper, logger core.Logger, database *gorm.DB)

func ListConnections

func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary get all tapd connections @Description Get all Tapd connections @Tags plugins/tapd @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections [GET]

func PatchConnection

func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary patch tapd connection @Description Patch Tapd connection @Tags plugins/tapd @Param body body models.TapdConnection true "json body" @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections/{connectionId} [PATCH]

func PostConnections

func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary create tapd connection @Description Create Tapd connection @Tags plugins/tapd @Param body body models.TapdConnection true "json body" @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections [POST]

func Proxy

func Proxy(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

func TestConnection

func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary test tapd connection @Description Test Tapd Connection @Tags plugins/tapd @Param body body models.TestConnectionRequest true "json body" @Success 200 {object} shared.ApiBody "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/test [POST]

Types

type StatusMappings

type StatusMappings struct {
	TodoStatus       []string `json:"todoStatus"`
	InProgressStatus []string `json:"inprogressStatus"`
	DoneStatus       []string `json:"doneStatus"`
}

type TapdBlueprintSetting

type TapdBlueprintSetting []struct {
	Version     string `json:"version"`
	Connections []struct {
		Plugin       string `json:"plugin"`
		ConnectionID int    `json:"connectionId"`
		Scope        []struct {
			Options struct {
				WorkspaceId         uint64   `mapstruct:"workspaceId"`
				CompanyId           uint64   `mapstruct:"companyId"`
				Tasks               []string `mapstruct:"tasks,omitempty"`
				Since               string
				TransformationRules TransformationRules `json:"transformationRules"`
			} `json:"options"`
			Entities []string `json:"entities"`
		} `json:"scope"`
	} `json:"connections"`
}

type TapdPipelinePlan

type TapdPipelinePlan [][]struct {
	Plugin   string   `json:"plugin"`
	Subtasks []string `json:"subtasks"`
	Options  struct {
		ConnectionId        uint64   `mapstruct:"connectionId"`
		WorkspaceId         uint64   `mapstruct:"workspaceId"`
		CompanyId           uint64   `mapstruct:"companyId"`
		Tasks               []string `mapstruct:"tasks,omitempty"`
		Since               string
		TransformationRules TransformationRules `json:"transformationRules"`
	} `json:"options"`
}

type TransformationRules

type TransformationRules struct {
	TypeMappings   TypeMappings   `json:"typeMappings"`
	StatusMappings StatusMappings `json:"statusMappings"`
}

type TypeMapping

type TypeMapping struct {
	StandardType string `json:"standardType"`
}

type TypeMappings

type TypeMappings map[string]TypeMapping