Skip to content

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

Merged
mutianf merged 2 commits into
googleapis:mainfrom
mutianf:docs/bigtable-agents-admin-guidance
Sep 30, 2026
Merged

mutianf merged 2 commits into
googleapis:mainfrom
mutianf:docs/bigtable-agents-admin-guidance

Conversation

@mutianf

@mutianf mutianf commented Sep 29, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Documents that bigtable/admin/apiv2/ is auto-generated from the Bigtable Admin proto and must not be edited directly; proto changes are the right entry point.
  • Points agents to the two generated clients as the authoritative reference when writing application code that calls admin operations:
    • bigtable_instance_admin_client.go — instance, cluster, app-profile ops
    • table_admin.go — table, backup, schema ops

Test plan

  • No code changes; documentation-only update to bigtable/AGENTS.md.

Remind agents that bigtable/admin/apiv2/ is auto-generated from the
Bigtable Admin proto and must not be edited directly, and point to the
two generated clients (instance admin and table admin) as the reference
when writing application code that calls admin operations.

Change-Id: I4c7a869ba2f81b3d7acc54ba6f29769993adcdd1
@mutianf
mutianf requested review from a team as code owners September 29, 2026 21:46
@product-auto-label product-auto-label Bot added the api: bigtable Issues related to the Bigtable API. label Sep 29, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

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.

Code Review

This pull request updates the bigtable/AGENTS.md file to include a new section with instructions for AI coding agents when editing admin operations. The review feedback correctly identifies an incorrect filename reference, pointing out that the BigtableTableAdmin client file is named bigtable_table_admin_client.go rather than table_admin.go.

Comment thread bigtable/AGENTS.md
`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

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.

@mutianf
mutianf merged commit 62ea97e into googleapis:main Sep 30, 2026
19 of 21 checks passed
@mutianf
mutianf deleted the docs/bigtable-agents-admin-guidance branch September 30, 2026 02:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigtable Issues related to the Bigtable API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants