Skip to content

docs(bigtable): document admin client guidance in AGENTS.md #20603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mutianf merged 2 commits into from
Sep 30, 2026
Merged

docs(bigtable): document admin client guidance in AGENTS.md #20603

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9a0802
docs(bigtable): document admin client guidance in AGENTS.md
mutianf Sep 29, 2026
48e477b
Merge branch 'main' into docs/bigtable-agents-admin-guidance
mutianf Sep 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions bigtable/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ These instructions apply to any AI coding agent (Claude Code, GitHub
Copilot, Gemini Code Assist, Cursor, Aider, etc.) editing files under
`bigtable/`.

## When editing admin operations

Admin RPCs (table/cluster/instance CRUD, backups, IAM, etc.) are implemented
in `bigtable/admin/apiv2/`, which is auto-generated from the Bigtable Admin
proto. Two rules apply:

- **Making changes to admin behavior** — `bigtable/admin/apiv2/` is
auto-generated from the Bigtable Admin proto; do not edit it directly.
Changes to admin RPCs must be made upstream in the proto definition.
- **Writing application code that calls admin operations** — use
`bigtable/admin/apiv2` as the authoritative reference for correct client
construction, request building, and error handling. There are two clients:
- `bigtable/admin/apiv2/bigtable_instance_admin_client.go` — instance, cluster, and app-profile operations
- `bigtable/admin/apiv2/table_admin.go` — table, backup, and schema operations

@gemini-code-assist gemini-code-assist Bot Sep 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The auto-generated client file for the BigtableTableAdmin service is named bigtable_table_admin_client.go rather than table_admin.go. Please update the filename to bigtable/admin/apiv2/bigtable_table_admin_client.go.


The higher-level `bigtable.AdminClient` wraps these; check `bigtable/admin/apiv2`
when the wrapper's behavior is unclear.

## When editing the Session subsystem

Before editing ANY file under:
Expand Down
Loading