From 07eed5cfb37ba1edabaa3a92d0788b85eed9941b Mon Sep 17 00:00:00 2001 From: Yusuke Tsutsumi Date: Thu, 7 Nov 2024 21:36:44 -0800 Subject: [PATCH] feat(8): adding style guide on error codes Since error codes can be succinct when describing gRPC and HTTP+JSON, we can just name them both in the AEPs. --- aep/general/0008/aep.md.j2 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/aep/general/0008/aep.md.j2 b/aep/general/0008/aep.md.j2 index da5504a2..a0fa24ef 100644 --- a/aep/general/0008/aep.md.j2 +++ b/aep/general/0008/aep.md.j2 @@ -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