Skip to content

fix(error): align templates with Error Specification ADR#48

Merged
yordis merged 1 commit intomainfrom
yordis/docs-google-rpc-error-template
May 6, 2026
Merged

fix(error): align templates with Error Specification ADR#48
yordis merged 1 commit intomainfrom
yordis/docs-google-rpc-error-template

Conversation

@yordis
Copy link
Copy Markdown
Member

@yordis yordis commented May 6, 2026

  • Grounds the protobuf projection in the accepted Error Specification ADR instead of treating it as a standalone design.
  • Keeps shared descriptors constrained to information that can cross publication boundaries safely.
  • Gives runtimes and generators a shared reference for stable ErrorInfo fields before method-level outcome work.

@cursor
Copy link
Copy Markdown

cursor Bot commented May 6, 2026

PR Summary

High Risk
High risk because it changes the Visibility proto enum (removes VISIBILITY_INTERNAL and renumbers values), which is a breaking wire-level change for any stored/serialized descriptors or generated code relying on prior numeric values.

Overview
Aligns trogon.error.v1alpha1 docs and proto comments with the Error Specification ADR and the Google RPC rich error model, including a new Google RPC Error Templates guide and expanded runtime-mapping examples.

Updates error-template conventions to use lowerCamelCase metadata keys and proto JSON names, and clarifies that VISIBILITY_UNSPECIFIED is invalid for emitted details.

Makes a breaking change to proto/trogon/error/v1alpha1/visibility.proto by removing VISIBILITY_INTERNAL and renumbering VISIBILITY_PRIVATE/VISIBILITY_PUBLIC, and tweaks consistency/error docs to match the new metadata naming (e.g., projectionTimeout, minVersion).

Reviewed by Cursor Bugbot for commit ccd396d. Bugbot is set up for automated code reviews on this repo. Configure here.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

Warning

Rate limit exceeded

@yordis has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 46 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 57c47505-b4ee-4325-a51d-5c400080c2ff

📥 Commits

Reviewing files that changed from the base of the PR and between 41f48a0 and ccd396d.

📒 Files selected for processing (8)
  • docs/README.md
  • docs/explanation/consistency-pattern.md
  • docs/explanation/google-rpc-error-template.md
  • docs/explanation/protobuf-extension-naming.md
  • docs/how-to/document-errors-in-proto.md
  • proto/trogon/consistency/v1alpha1/consistency.proto
  • proto/trogon/error/v1alpha1/options.proto
  • proto/trogon/error/v1alpha1/visibility.proto
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch yordis/docs-google-rpc-error-template

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed⏩ skippedMay 6, 2026, 5:42 AM

@yordis yordis force-pushed the yordis/docs-google-rpc-error-template branch from 459b2e1 to ca48c1f Compare May 6, 2026 04:31
@yordis yordis changed the title docs(error): anchor templates on Google RPC chore(error): anchor templates on Google RPC May 6, 2026
@yordis yordis force-pushed the yordis/docs-google-rpc-error-template branch 3 times, most recently from 776724a to eefc63b Compare May 6, 2026 05:17
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit eefc63b. Configure here.

Comment thread proto/trogon/error/v1alpha1/visibility.proto
@yordis yordis force-pushed the yordis/docs-google-rpc-error-template branch from eefc63b to 83b907d Compare May 6, 2026 05:28
@yordis yordis changed the title chore(error): anchor templates on Google RPC feat(error)!: align templates with Error Specification ADR May 6, 2026
@yordis yordis force-pushed the yordis/docs-google-rpc-error-template branch from 83b907d to 95a09c9 Compare May 6, 2026 05:35
@yordis yordis changed the title feat(error)!: align templates with Error Specification ADR feat(error): align templates with Error Specification ADR May 6, 2026
@yordis yordis force-pushed the yordis/docs-google-rpc-error-template branch from 95a09c9 to 3fc920a Compare May 6, 2026 05:37
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@yordis yordis changed the title feat(error): align templates with Error Specification ADR fix(error): align templates with Error Specification ADR May 6, 2026
@yordis yordis force-pushed the yordis/docs-google-rpc-error-template branch from 3fc920a to ccd396d Compare May 6, 2026 05:42
@yordis yordis merged commit 53ac7ec into main May 6, 2026
5 checks passed
@yordis yordis deleted the yordis/docs-google-rpc-error-template branch May 6, 2026 05:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant