-
Notifications
You must be signed in to change notification settings - Fork 1.2k
chore(.gemini): add GEMINI.md context file #3385
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.
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
Draft
quartzmo
wants to merge
1
commit into
googleapis:main
Choose a base branch
from
quartzmo:chore/add-gemini-context
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Google API Go Client (`google-api-go-client`) Context | ||
|
|
||
| ## Repository Overview | ||
| This repository contains the auto-generated Go client libraries for Google APIs, based on the **Discovery API**. | ||
|
|
||
| * **Nature of Code:** Almost every top-level directory (e.g., `calendar/`, `drive/`, `sheets/`) corresponds to a Google API and is **auto-generated**. | ||
| * **Editing:** Avoid manual edits to specific API clients unless absolutely necessary for debugging. Changes should ideally happen in the generator or the source discovery doc. | ||
|
|
||
| ## Key Directories | ||
| While most directories are clients, the following are the core libraries that support them: | ||
|
|
||
| * `googleapi/`: Contains common types, error handling, and JSON helpers used across all clients. **High importance** for cross-cutting concerns. | ||
| * `transport/`: Handles HTTP transport, authentication, and connection pooling. **Critical** for networking behavior. | ||
| * `option/`: Configuration options for clients (e.g., API keys, credentials, endpoints). | ||
| * `idtoken/`: Functionality for validating and generating Google ID tokens. | ||
| * `internal/`: Shared internal logic. | ||
|
|
||
| ## Architecture & Wiring | ||
| * **Transport Creation (`transport/http/dial.go`):** This is the **critical chokepoint** for all HTTP clients. `NewClient` calls `dial`, which constructs the `http.Client`. | ||
| * **Instrumentation Point:** This is the exact location to wrap the `http.Transport` (e.g., with OpenTelemetry) or inject middleware. | ||
| * **Configuration:** Users configure clients using `option.ClientOption` (found in `option/`). | ||
| * **`option.WithTracerProvider`:** This option flows into `dial.go` and determines the tracing provider. | ||
|
|
||
| ## Context | ||
| * **Difference from `google-cloud-go`:** These clients are based on the JSON Discovery format. They are typically pure REST/HTTP clients. The clients in `google-cloud-go` are often gRPC-based (GAPIC) and considered "idiomatic" for Google Cloud Platform services. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are all these details helpful outside the scope of work on tracing? My only concern is that this is sort of a "partial" architecture description that might limit the focus.
If the real meat of the clients is all in
dialandClientOptionthen this makes sense.