api

package

v0.14.5 Latest Latest Go to latest Published: Nov 22, 2022 License: Apache-2.0 Imports: 14 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/apache/incubator-devlake

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
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 PostJenkinsBluePrint(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
func PostJenkinsPipeline(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
type JenkinsBlueprintSetting
type JenkinsPipelinePlan

Constants ¶

This section is empty.

Variables ¶

View Source

var BasicRes core.BasicRes

Functions ¶

func DeleteConnection ¶ added in v0.12.0

func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.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, errors.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 ¶ added in v0.12.0

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 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 ¶ added in v0.12.0

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 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 ¶ added in v0.12.0

func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.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 ¶ added in v0.13.0

func PostJenkinsBluePrint(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.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 ¶ added in v0.13.0

func PostJenkinsPipeline(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.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, errors.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 ¶ added in v0.13.0

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 ¶ added in v0.13.0

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL