File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -9,10 +9,11 @@ placement:
99
1010# Errors
1111
12- Error handling is an important part of designing simple and intuitive APIs.
13- Consistent error handling allows developers to know how to expect to receive
14- errors, and to reduce boilerplate by having common error-handling logic, rather
15- than being expected to constantly add verbose error handling everywhere.
12+ Effective error communication is an important part of designing simple and
13+ intuitive APIs. Services returning standardized error responses enable API
14+ clients to construct centralized common error handling logic. This common logic
15+ simplifies API client appications and eliminates the need for cumbersome
16+ custom error handling code.
1617
1718## Guidance
1819
@@ -75,6 +76,7 @@ message. The errors themselves **must** still be represented with a
7576
7677## Changelog
7778
79+ - ** 2022-08-12** : Reworded/Simplified intro to add clarity to the intent.
7880- ** 2020-01-22** : Added a reference to the [ ` ErrorInfo ` ] [ ErrorInfo ] message.
7981- ** 2019-10-14** : Added guidance restricting error message mutability to if
8082 there is a machine-readable identifier present.
You can’t perform that action at this time.
0 commit comments