Docs/schedule inspection#2247
Conversation
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
BelhsanHmida
left a comment
BelhsanHmida
left a comment
There was a problem hiding this comment.
Thanks, this PR looks good overall. I made a small local pass over the docs and fixed a few typos/trailing whitespace issues.
I also left two small suggestions: one about the wording for the GET /api/v3_0/jobs/{uuid} endpoint, and one about mentioning the CLI inspection path.
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| There is an API endpoint specifically for checking status, result and configuration info for jobs: | ||
| ``GET /api/v3_0/jobs/{uuid}`` will return JSON with information, including the flex config and exception info. |
There was a problem hiding this comment.
Do you think we should avoid saying that GET /api/v3_0/jobs/{uuid} returns configuration info or flex config here? That endpoint returns status/result information, queue/function metadata, timestamps, and exc_info for failed jobs, but not the job metadata or scheduler flex-model/flex-context.
Maybe this could be reworded to something like:
GET /api/v3_0/jobs/{uuid} returns JSON with the job status, result, queue and function metadata, timestamps, and exception traceback information for failed jobs.
Also do you think we should add Checking the status via the CLI or api mention is enough ?
2 participants
Description
Users should know how to see results, config and errors on their jobs.
documentation/changelog.rstLook & feel