8000 Add a data model for error responses · evalcode/api-guidelines@2dc6824 · GitHub
[go: up one dir, main page]

Skip to content

Commit 2dc6824

Browse files
committed
Add a data model for error responses
1 parent fd40769 commit 2dc6824

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

Guidelines.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,31 @@ Error responses MAY contain [annotations][odata-json-annotations] in any of thei
392392

393393
We recommend that for any transient errors that may be retried, services SHOULD include a Retry-After HTTP header indicating the minimum number of seconds that clients SHOULD wait before attempting the operation again.
394394

395+
##### ErrorResponse : Object
396+
397+
Property | Type | Required | Description
398+
-------- | ---- | -------- | -----------
399+
`error` | Error | ✔ | The error object.
400+
401+
##### Error : Object
402+
403+
Property | Type | Required | Description
404+
-------- | ---- | -------- | -----------
405+
`code` | String (enumerated) | ✔ | One of a server-defined set of error codes.
406+
`message` | String | ✔ | A human-readable representation of the error.
407+
`target` | String | | The target of the error.
408+
`details` | Error[] | | An array of details about specific errors that led to this reported error.
409+
`innererror` | InnerError | | An object containing more specific information than the current object about the error.
410+
411+
##### InnerError : Object
412+
413+
Property | Type | Required | Description
414+
-------- | ---- | -------- | -----------
415+
`code` | String | | A more specific error code than was provided by the containing error.
416+
`innererror` | InnerError | | An object containing more specific information than the current object about the error.
417+
418+
##### Examples
419+
395420
Example of "innererror":
396421

397422
```json

0 commit comments

Comments
 (0)
0