aborgatin commented on a change in pull request #489: GRIFFIN-240 Return
JobInstanceBean in response to a call Trigger job by id
URL: https://github.com/apache/griffin/pull/489#discussion_r266855423
##########
File path: griffin-doc/service/api-guide.md
##########
@@ -549,7 +549,21 @@ curl -k -H "Content-Type: application/json" -H "Accept:
application/json" \
`POST /api/v1/jobs/trigger/{job_id}`
#### API Example
```
-curl -k -X POST http://127.0.0.1:8080/api/v1/jobs/trigger/51
+curl -k -X POST http://127.0.0.1:8080/api/v1/jobs/trigger/51 \
+-d '{
+ "timeout": "1000"
Review comment:
This timeout is the maximum time in milliseconds that we are waiting for the
creation of a JobInstanceBean.
The time between schedule job with "execute right now" trigger and the
actual execution the job may be differ (from several milliseconds to tens of
seconds).
Sometimes, for example, in requests from the UI, waiting for a
JobInstanceBean to be created is not required, because response will be
ignored.
But in other cases it can be very important. For example, we can run job
using this API from ETL. After that using JobInstance ID from response, we can
check the measurement result.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
