task

Documentation

Index

• func List(c *gin.Context)
• func Manager(c *gin.Context)
• func Post(c *gin.Context)

Functions

func List

func List(c *gin.Context)

List @Summary List @description Get the all task list @Tags Task @Accept application/json @Accept application/yaml @Produce application/json @Produce application/yaml @Param page query int false "page number" default(1) @Param size query int false "paging Size" default(100) @Param prefix query string false "Keywords" @Success 200 {object} types.Base[types.TaskListRes] @Failure 500 {object} types.Base[any] @Router /api/v1/task [get]

func Manager

func Manager(c *gin.Context)

Manager @Summary Manager @description Task management, can terminate, suspend, and resolve @Tags Task @Accept application/json @Accept application/yaml @Produce application/json @Produce application/yaml @Param task path string true "task name" @Param action query string false "management action" Enums(paused,kill,pause,resume) default(paused) @Param duration query string false "how long to pause; if empty, manual continuation is required" default(1m) @Success 200 {object} types.Base[any] @Failure 500 {object} types.Base[any] @Router /api/v1/task/{task} [put]

func Post

func Post(c *gin.Context)

Post @Summary Create @description Create a task @Tags Task @Accept application/json @Accept application/yaml @Accept multipart/form-data @Produce application/json @Produce application/yaml @param name query string false "task name" @Param async query bool false "task asynchronously" default(false) @Param timeout query string false "task timeout" @Param env query []string false "task envs" @Param steps body types.TaskStepsReq true "scripts" @Success 200 {object} types.Base[types.TaskCreateRes] @Failure 500 {object} types.Base[any] @Router /api/v1/task [post]