Skip to content

Commit

Permalink
Reworded/Simplified intro to add clarity to the intent. (aip-dev#932)
Browse files Browse the repository at this point in the history
* Reworded/Simplified intro to add clarity to the intent.

* Update aip/general/0193.md

Co-authored-by: Noah Dietz <[email protected]>

Co-authored-by: Noah Dietz <[email protected]>
  • Loading branch information
GregFurmanek and noahdietz authored Aug 16, 2022
1 parent 7ce2985 commit 89c7a1f
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions aip/general/0193.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ placement:

# Errors

Error handling is an important part of designing simple and intuitive APIs.
Consistent error handling allows developers to know how to expect to receive
errors, and to reduce boilerplate by having common error-handling logic, rather
than being expected to constantly add verbose error handling everywhere.
Effective error communication is an important part of designing simple and
intuitive APIs. Services returning standardized error responses enable API
clients to construct centralized common error handling logic. This common logic
simplifies API client appications and eliminates the need for cumbersome
custom error handling code.

## Guidance

Expand Down Expand Up @@ -75,6 +76,7 @@ message. The errors themselves **must** still be represented with a

## Changelog

- **2022-08-12**: Reworded/Simplified intro to add clarity to the intent.
- **2020-01-22**: Added a reference to the [`ErrorInfo`][ErrorInfo] message.
- **2019-10-14**: Added guidance restricting error message mutability to if
there is a machine-readable identifier present.
Expand Down

0 comments on commit 89c7a1f

Please sign in to comment.