controllers

Documentation

Index

• func AbortTaskExecution(c *gin.Context)
• func CreateTaskDefinition(c *gin.Context)
• func DeleteTaskDefinition(c *gin.Context)
• func GetAllPendingTaskDefinitions(c *gin.Context)
• func GetAllTaskDefinitions(c *gin.Context)
• func GetLatestExecution(c *gin.Context)
• func Ping(c *gin.Context)
• func RerunTask(c *gin.Context)
• func UpdateTaskDefinition(c *gin.Context)

Functions

func AbortTaskExecution

func AbortTaskExecution(c *gin.Context)

AbortTaskExecution godoc @Summary Abort a running task and kill the pod @Description Kill a running k8s job and update its task execution @Tags execution @Produce json @Param executionId path string true "The task execution id" @Success 200 @Router /api/v1/execution/{executionId}/abort [post]

func CreateTaskDefinition

func CreateTaskDefinition(c *gin.Context)

CreateTaskDefinition godoc @Summary Create a new task definition @Description Generate a new definition of a task to run with cadence, parameters and runtime data @Tags definition @Produce application/json @Param newTaskDef body models.TaskDefinition true "Task definition JSON" @Success 200 @Router /api/v1/task [post]

func DeleteTaskDefinition

func DeleteTaskDefinition(c *gin.Context)

DeleteTaskDefinition godoc @Summary Delete a task definition @Description Mark a task definition as deleted (it is not actually deleted from the db) @Tags definition @Produce application/json @Param definitionId path string true "The task definition id" @Success 200 @Router /api/v1/task/{definitionId} [delete]

func GetAllPendingTaskDefinitions

func GetAllPendingTaskDefinitions(c *gin.Context)

GetAllPendingTaskDefinitions godoc @Summary Get all of the pending task definitions @Description Filter to get the task pending tasks @Tags definition @Produce json @Success 200 {object} []models.TaskDefinition @Router /api/v1/task/pending [get]

func GetAllTaskDefinitions

func GetAllTaskDefinitions(c *gin.Context)

GetAllTaskDefinitions godoc @Summary Get all task definitions @Description Filter to get the task definitions you need @Tags definition @Produce json @Success 200 {object} []models.TaskDefinition @Router /api/v1/task [get]

func GetLatestExecution

func GetLatestExecution(c *gin.Context)

GetLatestExecution godoc @Summary Get the latest execution of a given definitions @Description Filter to get the task definitions you need @Tags definition @Produce json @Success 200 {object} []models.TaskExecution @Param definitionId path string true "The task definition id" @Router /api/v1/task/{definitionId}/latest [get]

func Ping

func Ping(c *gin.Context)

Ping godoc @Summary Health check route @Description Used for health check @Tags Health @Produce json @Success 200 @Router /ping [get]

func RerunTask

func RerunTask(c *gin.Context)

RerunTask godoc @Summary Rerun a task definition @Description Rerun a task definition previously created @Tags definition @Produce json @Param definitionId path string true "The task definition id" @Success 200 @Router /api/v1/task/{definitionId}/rerun [post]

func UpdateTaskDefinition

func UpdateTaskDefinition(c *gin.Context)

UpdateTaskDefinition godoc @Summary Update a task definition @Description Update a definition of a task to run with cadence, parameters and runtime data @Tags definition @Produce application/json @Param newTaskDef body models.TaskDefinition true "Task definition JSON" @Success 200 @Router /api/v1/task [put]