api

Documentation

Index

• 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 MakePipelinePlan(subtaskMetas []core.SubTaskMeta, connectionId uint64, ...) (core.PipelinePlan, errors.Error)
• func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
• type CodeTransformationRules
• type GithubBlueprintSetting
• type GithubPipelinePlan
• type GithubTestConnResponse

Functions

func DeleteConnection

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

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

func GetConnection

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

@Summary get github connection detail @Description Get github connection detail @Tags plugins/github @Success 200 {object} models.GithubConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/github/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 github connections @Description Get all github connections @Tags plugins/github @Success 200 {object} []models.GithubConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/github/connections [GET]

func MakePipelinePlan

func MakePipelinePlan(subtaskMetas []core.SubTaskMeta, connectionId uint64, scope []*core.BlueprintScopeV100) (core.PipelinePlan, errors.Error)

func PatchConnection

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

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

func PostConnections

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

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

func TestConnection

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

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

Types

type CodeTransformationRules

type CodeTransformationRules struct {
	PrType               string `mapstructure:"prType" json:"prType"`
	PrComponent          string `mapstructure:"prComponent" json:"prComponent"`
	PrBodyClosePattern   string `mapstructure:"prBodyClosePattern" json:"prBodyClosePattern"`
	IssueSeverity        string `mapstructure:"issueSeverity" json:"issueSeverity"`
	IssuePriority        string `mapstructure:"issuePriority" json:"issuePriority"`
	IssueComponent       string `mapstructure:"issueComponent" json:"issueComponent"`
	IssueTypeBug         string `mapstructure:"issueTypeBug" json:"issueTypeBug"`
	IssueTypeIncident    string `mapstructure:"issueTypeIncident" json:"issueTypeIncident"`
	IssueTypeRequirement string `mapstructure:"issueTypeRequirement" json:"issueTypeRequirement"`
}

type GithubBlueprintSetting

type GithubBlueprintSetting []struct {
	Version     string `json:"version"`
	Connections []struct {
		Plugin       string `json:"plugin"`
		ConnectionID int    `json:"connectionId"`
		Scope        []struct {
			Transformation CodeTransformationRules `json:"transformation"`
			Options        struct {
				Owner string `json:"owner"`
				Repo  string `json:"repo"`
				Since string
			} `json:"options"`
			Entities []string `json:"entities"`
		} `json:"scope"`
	} `json:"connections"`
}

type GithubPipelinePlan

type GithubPipelinePlan [][]struct {
	Plugin   string   `json:"plugin"`
	Subtasks []string `json:"subtasks"`
	Options  struct {
		ConnectionID   int    `json:"connectionId"`
		Owner          string `json:"owner"`
		Repo           string `json:"repo"`
		Since          string
		Transformation CodeTransformationRules `json:"transformation"`
	} `json:"options"`
}

type GithubTestConnResponse

type GithubTestConnResponse struct {
	shared.ApiBody
	Login string `json:"login"`
}