Extend each Fault message to include verbose information
Today, each Fault message may include HTTP Error Code, Message and a Detailed message.
I would suggest to allow the user / client to set a header parameter, say "verbose_level" = "Low" | "Regular" | "High", and the Fault response will include more verbose information about what was the cause of the problem. This functionality will be most usefull in non-straight forward scenarios, in a long complecated a-sync process, in which the backend will allow inform the client more detailed information.
Blueprint information
- Status:
- Complete
- Approver:
- None
- Priority:
- Undefined
- Drafter:
- None
- Direction:
- Needs approval
- Assignee:
- None
- Definition:
- Obsolete
- Series goal:
- None
- Implementation:
-
Unknown
- Milestone target:
- None
- Started by
- Completed by
- Maty Grosz
Whiteboard
I would also include such a response section withing list{Resource} or get{Resource} APIs, so that in case of a-sync requests, like create a new {Resource}, when the client is supposed to start calling to the list{Resource} or get{Resource} APIs till the resource is in ACTIVE state - the verbose message will inform the user about failures during the creation process.
