AIP-193: Errors¶
Google. AIP-193: Errors. Google API Improvement Proposals / API Design Guide.
Cited by¶
1 citation across 1 artifact.
Each citation links to the sentence it supports in the citing article.
Primes¶
- Inverted Pyramid
- Incident reports and runbooks. On-call alerts, status pages, and tickets lead with severity, scope, and action required, then diagnostic detail, because an engineer paged at 3am benefits from prefix-loaded structure. API responses and error messages. Top-level error code and user-actionable message first; stack trace and debug context afterward.
This sourceGoogle LLC. Specifies the standard API error model — a top-level numeric error code and a developer-facing message first, with machine-readable ErrorInfo and additional debug details in the error 'details' payload — i.e. user-actionable fields before diagnostic detail.
- Incident reports and runbooks. On-call alerts, status pages, and tickets lead with severity, scope, and action required, then diagnostic detail, because an engineer paged at 3am benefits from prefix-loaded structure. API responses and error messages. Top-level error code and user-actionable message first; stack trace and debug context afterward.
Verification¶
This reference passed the adversarial substantiation pipeline: it was checked to exist and to support the claim it is attached to. See how references were verified.
Registry ID ref:4f6707738381 · see in the full table