Help us shape the future of Go! Take the 2026 Go Developer Survey

pipelines

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 29, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 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 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 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 @Description RETURN SAMPLE @Description { @Description "pipelines": [ @Description {"id": 1, "name": "test-pipeline", ...} @Description ], @Description "count": 5 @Description } @Tags 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} models.Pipeline @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 @Description RETURN SAMPLE @Description { @Description "name": "name-of-pipeline", @Description "tasks": [ @Description [ {"plugin": "gitlab", ...}, {"plugin": "jira"} ], @Description [ {"plugin": "github", ...}], @Description ] @Description } @Tags pipelines @Accept application/json @Param pipeline body string true "json" @Success 200 {object} models.Pipeline @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /pipelines [post]

Types

This section is empty.

Jump to

Keyboard shortcuts

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