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
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -301,9 +301,9 @@ There are 2 kinds of errors:
301
301
302
302
: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.
303
303
304
-
: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
+
:heavy_check_mark:**YOU MAY**group common customer code errors into a few `x-ms-error-code`string values.
305
305
306
-
:white_check_mark:**DO**document the service's error code strings; they are part of the API contract.
306
+
:white_check_mark:**DO**ensure that the top-level error's `code` value is identical to the `x-ms-error-code` header's value.
307
307
308
308
:white_check_mark:**DO** provide a response body with the following structure:
309
309
@@ -346,7 +346,7 @@ Example:
346
346
}
347
347
```
348
348
349
-
:heavy_check_mark:**YOU MAY**group common customer code errors into a few `x-ms-error-code` string values.
349
+
:white_check_mark:**DO**document the service's top-level error code strings; they are part of the API contract.
350
350
351
351
: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