apirunbooks

Documentation

Index

• func List(c *gin.Context)
• func ListByConnection(c *gin.Context)
• func RunExec(c *gin.Context)

Functions

func List

func List(c *gin.Context)

ListRunbooks

@Summary		List Runbooks
@Description	List all Runbooks
@Tags			Core
@Produce		json
@Success		200			{object}	openapi.RunbookList
@Failure		404,422,500	{object}	openapi.HTTPError
@Router			/plugins/runbooks/templates [get]

func ListByConnection

func ListByConnection(c *gin.Context)

ListRunbooksByConnection

@Summary		List Runbooks By Connection
@Description	List Runbooks templates by connection
@Tags			Core
@Produce		json
@Param			name			path		string	true	"The name of the connection"
@Success		200				{object}	openapi.RunbookList
@Failure		400,404,422,500	{object}	openapi.HTTPError
@Router			/plugins/runbooks/connections/{name}/templates [get]

func RunExec

func RunExec(c *gin.Context)

RunRunbookExec

@Summary		Runbook Exec
@Description	Start a execution using a Runbook as input
@Tags			Core
@Accept			json
@Produce		json
@Param			name			path		string					true	"The name of the connection"
@Param			request			body		openapi.RunbookRequest	true	"The request body resource"
@Success		200				{object}	openapi.ExecResponse	"The execution has finished"
@Success		202				{object}	openapi.ExecResponse	"The execution is still in progress"
@Failure		400,404,422,500	{object}	openapi.HTTPError
@Router			/plugins/runbooks/connections/{name}/exec [post]