httpd: update comment on HTTP API to get JobExec log

Simplify the comment without heading "#", following the other comment format.
shuLhan · Feb 27, 2024 · 3974342 · 3974342
1 parent cc8d4c2
commit 3974342
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/httpd.go b/httpd.go
@@ -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) {