~shulhan/karajo

3974342afc47073127eaddca7edd6fca7e4bb869 — Shulhan 3 months ago cc8d4c2
httpd: update comment on HTTP API to get JobExec log

Simplify the comment without heading "#", following the other comment
format.
1 files changed, 8 insertions(+), 4 deletions(-)

M httpd.go
M httpd.go => httpd.go +8 -4
@@ 426,13 426,17 @@ func (k *Karajo) apiJobExecCancel(epr *libhttp.EndpointRequest) (resbody []byte,

// apiJobExecLog get the JobExec log by its ID and counter.
//
// # Request
//
// Format,
// Request format,
//
//	GET /karajo/api/job_exec/log?id=<jobID>&counter=<counter>
//
// # Response
// Response format,
//
//	content-encoding: gzip
//	content-type: application/json
//	{
//		"data": <JobLog>
//	}
//
// If the jobID and counter exist it will return the JobLog object as JSON.
func (k *Karajo) apiJobExecLog(epr *libhttp.EndpointRequest) (resbody []byte, err error) {