Skip to content

Commit

Permalink
feat(8): adding style guide on error codes (#245)
Browse files Browse the repository at this point in the history
Since error codes can be succinct when describing gRPC and
HTTP+JSON, we can just name them both in the AEPs.
  • Loading branch information
toumorokoshi authored Nov 16, 2024
1 parent eff5366 commit fe52c14
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions aep/general/0008/aep.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,10 @@ subdirectory); this ensures that the link works both on the AEP site, when
viewing the Markdown file on GitHub, using the local development server, or a
branch.

### Error codes

When referencing a error code, the prose **should** use the format `{google.api.error_code} / {http_status_code}`. For example, `OK / 200`.

## Rationale

### Designing for a broad set of clients
Expand Down

0 comments on commit fe52c14

Please sign in to comment.