api

Documentation

Index

• func GetProcessLogs(c *gin.Context)
• func GetProcesses(c *gin.Context)
• func InitRoutes(useLogger bool) *gin.Engine
• func StartProcess(c *gin.Context)
• func StopProcess(c *gin.Context)

Functions

func GetProcessLogs

func GetProcessLogs(c *gin.Context)

@Schemes @Description Retrieves the process logs @Tags Process @Summary Get process logs @Produce json @Param name path string true "Process Name" @Param endOffset path int true "Offset from the end of the log" @Param limit path int true "Limit of lines to get (0 will get all the lines till the end)" @Success 200 {object} object "Process Logs" @Router /process/logs/{name}/{endOffset}/{limit} [get]

func GetProcesses

func GetProcesses(c *gin.Context)

@Schemes @Description Retrieves all the configured processes and their status @Tags Process @Summary Get all processes @Produce json @Success 200 {object} object "Processes Status" @Router /processes [get]

func InitRoutes

func InitRoutes(useLogger bool) *gin.Engine

InitRoutes initialize routing information

func StartProcess

func StartProcess(c *gin.Context)

@Schemes @Description Starts the process if the state is not 'running' or 'pending' @Tags Process @Summary Start a process @Produce json @Param name path string true "Process Name" @Success 200 {string} string "Started Process Name" @Router /process/start/{name} [post]

func StopProcess

func StopProcess(c *gin.Context)

@Schemes @Description Sends kill signal to the process @Tags Process @Summary Stop a process @Produce json @Param name path string true "Process Name" @Success 200 {string} string "Stopped Process Name" @Router /process/stop/{name} [patch]