api

Documentation

Index

• func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func Init(config *viper.Viper, logger core.Logger, database *gorm.DB)
• func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func MakePipelinePlan(subtaskMetas []core.SubTaskMeta, connectionId uint64, ...) (core.PipelinePlan, error)
• func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func PostJenkinsBluePrint(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func PostJenkinsPipeline(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• type JenkinsBlueprintSetting
• type JenkinsPipelinePlan

Functions

func DeleteConnection

func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

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

func GetConnection

func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

@Summary get jenkins connection detail @Description Get Jenkins connection detail @Tags plugins/jenkins @Success 200 {object} models.JenkinsConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/jenkins/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, error)

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

func MakePipelinePlan

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

func PatchConnection

func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

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

func PostConnections

func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

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

func PostJenkinsBluePrint

func PostJenkinsBluePrint(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

@Summary blueprints setting for jenkins @Description blueprint setting for jenkins @Tags plugins/jenkins @Accept application/json @Param blueprint body JenkinsBlueprintSetting true "json" @Router /blueprints/jenkins/blueprint-setting [post]

func PostJenkinsPipeline

func PostJenkinsPipeline(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

@Summary pipelines plan for jenkins @Description pipelines plan for jenkins @Tags plugins/jenkins @Accept application/json @Param blueprint body JenkinsPipelinePlan true "json" @Router /pipelines/jenkins/pipeline-plan [post]

func TestConnection

func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

@Summary test jenkins connection @Description Test Jenkins Connection @Tags plugins/jenkins @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/jenkins/test [POST]

Types

type JenkinsBlueprintSetting

type JenkinsBlueprintSetting []struct {
	Version     string `json:"version"`
	Connections []struct {
		Plugin       string `json:"plugin"`
		ConnectionID int    `json:"connectionId"`
		Scope        []struct {
			Options struct {
			} `json:"options"`
			Entities []string `json:"entities"`
		} `json:"scope"`
	} `json:"connections"`
}

type JenkinsPipelinePlan

type JenkinsPipelinePlan [][]struct {
	Plugin   string   `json:"plugin"`
	Subtasks []string `json:"subtasks"`
	Options  struct {
		ConnectionID int `json:"connectionId"`
	} `json:"options"`
}