Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: require unique error details messages #1087

Merged
merged 3 commits into from
May 9, 2023
Merged

feat: require unique error details messages #1087

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b22ac1e
feat: require unique error details messages
shwoodard May 4, 2023
09b4206
fix typo: double "not"
shwoodard May 9, 2023
2cb3652
Correct "Uniqueness" to say, "at most once"
shwoodard May 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions aip/general/0193.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,18 @@ error message **must** be considered a backwards-incompatible change.
**Note:** The [`ErrorInfo`][ErrorInfo] message is the recommended way to send a
machine-readable identifier.

#### Uniqueness

Each type of detail payload **must** be included at most once. For
example, there **must not** be more than one `ErrorInfo` message in the
`details` field, but there **may** be an `ErrorInfo` and a
[`PreconditionFailure`][PreconditionFailure].

### Localization

Error messages **must** be in English. If a localized error message is also
required, the service **should** use [`google.rpc.LocalizedMessage`][details]
as the `details` field.
in the `details` field.

### Partial errors

Expand Down Expand Up @@ -86,6 +93,7 @@ does not exist, the service **must** error with `NOT_FOUND` (HTTP 404).

## Changelog

- **2023-05-04**: Require uniqueness by message type for error details.
- **2022-11-04**: Added guidance around PERMISSION_DENIED errors previously
found in other AIPs.
- **2022-08-12**: Reworded/Simplified intro to add clarity to the intent.
Expand All @@ -98,7 +106,8 @@ does not exist, the service **must** error with `NOT_FOUND` (HTTP 404).
<!-- prettier-ignore-start -->
[aip-4221]: ../client-libraries/4221.md
[details]: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto
[ErrorInfo]: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto#L51
[ErrorInfo]: https://github.com/googleapis/googleapis/blob/6f3fcc058ff29989f6d3a71557a44b5e81b897bd/google/rpc/error_details.proto#L27-L76
[PreconditionFailure]: https://github.com/googleapis/googleapis/blob/6f3fcc058ff29989f6d3a71557a44b5e81b897bd/google/rpc/error_details.proto#L139-L166
shwoodard marked this conversation as resolved.
Show resolved Hide resolved
[grpc status code documentation]: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
[Code]: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
[Status]: https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto
Expand Down