AIP-193: Errors

Google. AIP-193: Errors. Google API Improvement Proposals / API Design Guide.

Type

Standard

Intellectual base

Reference work

Link

https://google.aip.dev/193

Cited from

communication_media_studies

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.

    Supported in partVerified against the work's full text

    AIP-193 backs the API-error half: a code and brief actionable message, with extra and debug information in a separate details field. It says nothing about incident reports, runbooks or on-call alerts.

    “Error messages should be brief but actionable. Any extra information should be provided in the details field.”

    Read by an automated reader; not a human review. How support was checked

Verification

Does it exist? Not checked yet. This entry carries no identifier to resolve. It was extracted from the citation as written in the article, normalized, and deduplicated against the rest of the registry.

Does it back the claim? Read against the text for 1 of 1 citation: 1 supported in part. Each verdict is shown under its citation below, with what in the work backs the sentence.

Support is checked per citation rather than per work — the same source can be cited soundly in one article and wrongly in another. Per-citation recording began recently, so a citation with no recorded check is a gap in the record rather than evidence it went unchecked.

See how references were verified.

Registry ID ref:4f6707738381 · see in the full table