You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: azure/Guidelines.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -300,6 +300,8 @@ There are 2 kinds of errors:
300
300
301
301
:white_check_mark:**DO** carefully craft unique `x-ms-error-code` string values for errors that are recoverable at runtime. Reuse common error codes for usage errors that are not recoverable.
302
302
303
+
:heavy_check_mark:**YOU MAY** group common customer code errors into a few `x-ms-error-code` string values.
304
+
303
305
:white_check_mark:**DO** ensure that the top-level error's `code` value is identical to the `x-ms-error-code` header's value.
304
306
305
307
:white_check_mark:**DO** provide a response body with the following structure:
@@ -343,8 +345,6 @@ Example:
343
345
}
344
346
```
345
347
346
-
:heavy_check_mark:**YOU MAY** group common customer code errors into a few `x-ms-error-code` string values.
347
-
348
348
:white_check_mark:**DO** document the service's top-level error code strings; they are part of the API contract.
349
349
350
350
:heavy_check_mark:**YOU MAY** treat the other fields as you wish as they are _not_ considered part of your service's API contract and customers should not take a dependency on them or their value. They exist to help customers self-diagnose issues.
0 commit comments