Skip to content

Commit fadddfa

Browse files
committed
PR feedback
1 parent 297b0a5 commit fadddfa

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

azure/Guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,8 @@ There are 2 kinds of errors:
300300

301301
: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.
302302

303+
:heavy_check_mark: **YOU MAY** group common customer code errors into a few `x-ms-error-code` string values.
304+
303305
:white_check_mark: **DO** ensure that the top-level error's `code` value is identical to the `x-ms-error-code` header's value.
304306

305307
:white_check_mark: **DO** provide a response body with the following structure:
@@ -343,8 +345,6 @@ Example:
343345
}
344346
```
345347

346-
:heavy_check_mark: **YOU MAY** group common customer code errors into a few `x-ms-error-code` string values.
347-
348348
:white_check_mark: **DO** document the service's top-level error code strings; they are part of the API contract.
349349

350350
: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

Comments
 (0)