pipelines

Documentation

Index

• func Delete(c *gin.Context)
• func DownloadLogs(c *gin.Context)
• func Get(c *gin.Context)
• func Index(c *gin.Context)
• func Post(c *gin.Context)

Functions

func Delete

func Delete(c *gin.Context)

Cancel a pending pipeline DELETE /pipelines/:pipelineId

@Cancel a pending pipeline @Description Cancel a pending pipeline @Tags framework/pipelines @Param pipelineId path int true "pipeline ID" @Success 200 @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /pipelines/{pipelineId} [delete]

func DownloadLogs

func DownloadLogs(c *gin.Context)

Get download logs of a pipeline GET /pipelines/:pipelineId/logging.tar.gz

download logs of a pipeline @Description GET /pipelines/:pipelineId/logging.tar.gz @Tags framework/pipelines @Param pipelineId path int true "query" @Success 200 "The archive file" @Failure 400 {string} errcode.Error "Bad Request" @Failure 404 {string} errcode.Error "Pipeline or Log files not found" @Failure 500 {string} errcode.Error "Internel Error" @Router /pipelines/{pipelineId}/logging.tar.gz [get]

func Get

func Get(c *gin.Context)

Get detail of a pipeline GET /pipelines/:pipelineId

{
	"id": 1,
	"name": "test-pipeline",
	...
}

@Get detail of a pipeline @Description GET /pipelines/:pipelineId @Description RETURN SAMPLE @Description { @Description "id": 1, @Description "name": "test-pipeline", @Description ... @Description } @Tags framework/pipelines @Param pipelineId path int true "query" @Success 200 {object} models.Pipeline @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /pipelines/{pipelineId} [get]

func Index

func Index(c *gin.Context)

@Summary Get list of pipelines @Description GET /pipelines?status=TASK_RUNNING&pending=1&page=1&pagesize=10 @Tags framework/pipelines @Param status query string true "query" @Param pending query int true "query" @Param page query int true "query" @Param pagesize query int true "query" @Success 200 {object} shared.ResponsePipelines @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /pipelines [get]

func Post

func Post(c *gin.Context)

Create and run a new pipeline POST /pipelines

{
	"name": "name-of-pipeline",
	"tasks": [
		[ {"plugin": "gitlab", ...}, {"plugin": "jira"} ],
		[ {"plugin": "github", ...}],
	]
}

@Summary Create and run a new pipeline @Description Create and run a new pipeline @Tags framework/pipelines @Accept application/json @Param pipeline body models.NewPipeline true "json" @Success 200 {object} models.Pipeline @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /pipelines [post]