shared

Documentation

Index

• Variables
• func GetCoreServiceH(a lib.Api) (string, string, gin.HandlerFunc)
• func GetCoreServicesH(a lib.Api) (string, string, gin.HandlerFunc)
• func GetEndpointH(a lib.Api) (string, string, gin.HandlerFunc)
• func GetEndpointsH(a lib.Api) (string, string, gin.HandlerFunc)
• func GetJobH(a lib.Api) (string, string, gin.HandlerFunc)
• func GetJobsH(a lib.Api) (string, string, gin.HandlerFunc)
• func GetLogH(a lib.Api) (string, string, gin.HandlerFunc)
• func GetLogsH(a lib.Api) (string, string, gin.HandlerFunc)
• func GetSrvInfo(a lib.Api) (string, string, gin.HandlerFunc)
• func PatchJobCancelH(a lib.Api) (string, string, gin.HandlerFunc)
• func PatchRestartCoreServiceH(a lib.Api) (string, string, gin.HandlerFunc)
• func PostEndpointAliasH(a lib.Api) (string, string, gin.HandlerFunc)

Variables

var Routes = gin_mw.Routes[lib.Api]{
	GetEndpointsH,
	GetEndpointH,
	PostEndpointAliasH,
	GetCoreServicesH,
	GetCoreServiceH,
	PatchRestartCoreServiceH,
	GetJobsH,
	GetJobH,
	PatchJobCancelH,
	GetLogsH,
	GetLogH,
	GetSrvInfo,
}

Functions

func GetCoreServiceH

func GetCoreServiceH(a lib.Api) (string, string, gin.HandlerFunc)

GetCoreServiceH @Summary Get service @Description Get core service including image and container information. @Tags Core Services @Produce json @Param name path string true "service name" @Success 200 {object} lib_model.CoreService "service" @Failure 500 {string} string "error message" @Router /core-services/{name} [get]

func GetCoreServicesH

func GetCoreServicesH(a lib.Api) (string, string, gin.HandlerFunc)

GetCoreServicesH @Summary List services @Description List core services including image and container information. @Tags Core Services @Produce json @Success 200 {object} map[string]lib_model.CoreService "services" @Failure 500 {string} string "error message" @Router /core-services [get]

func GetEndpointH

func GetEndpointH(a lib.Api) (string, string, gin.HandlerFunc)

GetEndpointH @Summary Get endpoint @Description Get HTTP endpoint. @Tags HTTP Endpoints @Produce json @Param id path string true "endpoint id" @Success 200 {object} map[string]lib_model.Endpoint "endpoints" @Failure 404 {string} string "error message" @Failure 500 {string} string "error message" @Router /endpoints [get]

func GetEndpointsH

func GetEndpointsH(a lib.Api) (string, string, gin.HandlerFunc)

GetEndpointsH @Summary List endpoints @Description List HTTP endpoints. @Tags HTTP Endpoints @Produce json @Param ids query string false "comma seperated list of endpoint ids (e.g.: id1,id2,...)" @Param ref query string false "reference value (e.g.: a foreign id)" @Param labels query string false "comma seperated list of labels (e.g.: key1=val1,key2=val2,...)" @Success 200 {object} map[string]lib_model.Endpoint "endpoints" @Failure 400 {string} string "error message" @Failure 500 {string} string "error message" @Router /endpoints [get]

func GetJobH

func GetJobH(a lib.Api) (string, string, gin.HandlerFunc)

GetJobH @Summary Get job @Description Get a job. @Tags Jobs @Produce json @Param id path string true "job id" @Success 200 {object} job_hdl_lib.Job "job" @Failure 404 {string} string "error message" @Failure 500 {string} string "error message" @Router /jobs/{id} [get]

func GetJobsH

func GetJobsH(a lib.Api) (string, string, gin.HandlerFunc)

GetJobsH @Summary List jobs @Description List all jobs. @Tags Jobs @Produce json @Param status query string false "status to filter by (pending,running,canceled,completed,error,ok)" @Param sort_desc query bool false "sort in descending order" @Param since query string false "list jobs since timestamp" @Param until query string false "list jobs until timestamp" @Success 200 {array} job_hdl_lib.Job "jobs" @Failure 400 {string} string "error message" @Failure 500 {string} string "error message" @Router /jobs [get]

func GetLogH

func GetLogH(a lib.Api) (string, string, gin.HandlerFunc)

GetLogH @Summary Get Log @Description Get log of a core services. @Tags Logs @Produce plain @Param id path string true "log id" @Param max_lines query string false "maximum number of lines to return" @Success 200 {string} string "log entries" @Failure 400 {string} string "error message" @Failure 404 {string} string "error message" @Failure 500 {string} string "error message" @Router /logs/{id} [get]

func GetLogsH

func GetLogsH(a lib.Api) (string, string, gin.HandlerFunc)

GetLogsH @Summary List logs @Description List logs of core services not running as containers. @Tags Logs @Produce json @Success 200 {object} map[string]lib_model.Log "logs" @Failure 500 {string} string "error message" @Router /logs [get]

func GetSrvInfo

func GetSrvInfo(a lib.Api) (string, string, gin.HandlerFunc)

GetSrvInfo @Summary Get service info @Description Get basic service and runtime information. @Tags Info @Produce json @Success 200 {object} lib.SrvInfo "info" @Failure 500 {string} string "error message" @Router /info [get]

func PatchJobCancelH

func PatchJobCancelH(a lib.Api) (string, string, gin.HandlerFunc)

PatchJobCancelH @Summary Cancel job @Description Cancels a job. @Tags Jobs @Param id path string true "job id" @Success 200 @Failure 404 {string} string "error message" @Failure 500 {string} string "error message" @Router /jobs/{id}/cancel [patch]

func PatchRestartCoreServiceH

func PatchRestartCoreServiceH(a lib.Api) (string, string, gin.HandlerFunc)

PatchRestartCoreServiceH @Summary Restart service @Description Restart core service container. @Tags Core Services @Produce plain @Param name path string true "service name" @Success 200 {string} string "job ID" @Failure 500 {string} string "error message" @Router /core-services/{name}/restart [patch]

func PostEndpointAliasH

func PostEndpointAliasH(a lib.Api) (string, string, gin.HandlerFunc)

PostEndpointAliasH @Summary Create endpoint alias @Description Create an endpoint alias. @Tags HTTP Endpoints @Accept json @Produce plain @Param id path string true "endpoint id" @Param alias body lib_model.EndpointAliasReq false "endpoint alias information" @Success 200 {string} string "job ID" @Failure 400 {string} string "error message" @Failure 404 {string} string "error message" @Failure 500 {string} string "error message" @Router /endpoints/{id}/alias [post]