[Rest API] Add task state; Add job's retry details; Refine job config #2306
Conversation
sunqinzheng
commented
Mar 11, 2019
•
sunqinzheng
commented
- add task state field
- add job's retry details field
- refine job config api
- use request's Accept header to determine whether json or yaml will be sent.
- BREAK CHANGE: fix the bug that old job config api may return an escaped json string instead of a json object
| retries: retriedCount, | ||
| // sum of retries | ||
| retries: retries, | ||
| retryDetails: { |
There was a problem hiding this comment.
better name to be retryBreakdown?
There was a problem hiding this comment.
I think "details" is better...
docs/rest-server/API.md
Outdated
| // Job failed due to user or unknown error | ||
| user: userRetries, | ||
| // Job failed due to system/plaform error | ||
| system: systemRetries, |
There was a problem hiding this comment.
"platform" is better than "system" due to:
- More accurate, user job may also be a "system"
- Our PAI is "platform" for AI, not "system" for AI
- There are PaaS, but no "system" as a Service
so can you replace all "system" words with "platform" in this PR?
There was a problem hiding this comment.
I find that "system" is used in rest api document (https://github.com/Microsoft/pai/blob/master/docs/rest-server/API.md#post-token) multiple times. Shall we replace them as well?
There was a problem hiding this comment.
Seems there is no need to distingush with user in that doc, so no ambiguity in the doc (the "system" in the doc implies PAI).
So, it is better to replace "in the system" to "in PAI", but it is not necessary, it depends on you :)
