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)
• func PostRerun(c *gin.Context)

Functions

func Delete

func Delete(c *gin.Context)

@Summary 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 "Internal Error" @Router /pipelines/{pipelineId} [delete]

func DownloadLogs

func DownloadLogs(c *gin.Context)

@Summary 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 "Internal Error" @Router /pipelines/{pipelineId}/logging.tar.gz [get]

func Get

func Get(c *gin.Context)

@Summary 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 "Internal 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&label=search_text&page=1&pagesize=10 @Tags framework/pipelines @Param status query string false "status" @Param pending query int false "pending" @Param page query int false "page" @Param pagesize query int false "pagesize" @Param blueprint_id query int false "blueprint_id" @Param label query string false "label" @Success 200 {object} shared.ResponsePipelines @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /pipelines [get]

func Post

func Post(c *gin.Context)

@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]

func PostRerun

func PostRerun(c *gin.Context)

RerunPipeline rerun all failed tasks of the specified pipeline @Summary rerun tasks @Tags framework/pipelines @Accept application/json @Param pipelineId path int true "pipelineId" @Success 200 {object} []models.Task @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /pipelines/{pipelineId}/rerun [post]