Skip to content

Remove an unnecessary includeDebugDetails #8857

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Remove an unnecessary includeDebugDetails #8857

wants to merge 3 commits into from

Conversation

fredzqm
Copy link
Contributor

@fredzqm fredzqm commented Jul 17, 2025

It was in the wrong place. includeDebugDetails should be inside impersonate.

Copy link
Contributor

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

Choose a reason for hiding this comment

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

Summary of Changes

Hello @fredzqm, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request aims to simplify the data contract for GraphQL requests by removing a field that is no longer necessary. This change cleans up the ExecuteGraphqlRequest interface, making it leaner and potentially reducing complexity in related code paths.

Highlights

  • API Contract Simplification: The includeDebugDetails boolean property has been removed from the extensions object within the ExecuteGraphqlRequest interface. This streamlines the GraphQL request payload by eliminating an unnecessary field.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@fredzqm fredzqm requested a review from hlshen July 17, 2025 00:07
Copy link
Contributor

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

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 removes the includeDebugDetails property from the ExecuteGraphqlRequest interface. This appears to be an appropriate cleanup of an unused field, improving code clarity. I've added one suggestion to further improve the maintainability of the ExecuteGraphqlRequest interface by using a named type for the extensions property.

@@ -220,7 +220,7 @@ export interface ExecuteGraphqlRequest {
query: string;
operationName?: string;
variables?: { [key: string]: string };
extensions?: { impersonate?: Impersonation; includeDebugDetails?: boolean };
extensions?: { impersonate?: Impersonation; };
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For improved readability and long-term maintainability, consider extracting the inline object type for extensions into its own named interface. This makes the ExecuteGraphqlRequest interface's definition cleaner and allows the extensions type to be reused or exported if needed in the future.

For example, you could define a new interface:

export interface GraphqlRequestExtensions {
  impersonate?: Impersonation;
}

And then use it in ExecuteGraphqlRequest as suggested.

Suggested change
extensions?: { impersonate?: Impersonation; };
extensions?: GraphqlRequestExtensions;

@fredzqm fredzqm enabled auto-merge (squash) July 17, 2025 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant