Skip to content

fix(retail): add region tag for Java - Update Search with query expansion spec #10112

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 7 commits into
base: main
Choose a base branch
from

Conversation

rebeccaellis
Copy link
Contributor

Description

Fixes #415382524

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

Checklist

  • I have followed Sample Format Guide
  • pom.xml parent set to latest shared-configuration
  • Appropriate changes to README are included in PR
  • These samples need a new API enabled in testing projects to pass (let us know which ones)
  • These samples need a new/updated env vars in testing projects set to pass (let us know which ones)
  • Tests pass: mvn clean verify required
  • Lint passes: mvn -P lint checkstyle:check required
  • Static Analysis: mvn -P lint clean compile pmd:cpd-check spotbugs:check advisory only
  • This sample adds a new sample directory, and I updated the CODEOWNERS file with the codeowners for this sample
  • This sample adds a new Product API, and I updated the Blunderbuss issue/PR auto-assigner with the codeowners for this sample
  • Please merge this PR for me once it is approved

@rebeccaellis rebeccaellis requested review from yoshi-approver and a team as code owners June 27, 2025 23:59
Copy link

snippet-bot bot commented Jun 28, 2025

Here is the summary of changes.

You are about to add 1 region tag.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label bot added api: retail Issues related to the Retail API API. samples Issues that are directly related to samples. labels Jun 28, 2025
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 @rebeccaellis, 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 improves the discoverability and reusability of a Java code sample for the Retail API's search functionality. By introducing specific region tags, the searchResponse method within the SearchWithQueryExpansionSpec.java file can now be easily identified and extracted for inclusion in documentation or tutorials, ensuring consistency between code and documentation.

Highlights

  • Documentation: Added [START] and [END] region tags to the SearchWithQueryExpansionSpec.java sample. These tags specifically delineate the searchResponse method, enabling automated extraction of this code snippet for documentation purposes.
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.

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 adds region tags to the SearchWithQueryExpansionSpec.java sample. The changes are functionally correct, but there are a couple of minor style and consistency issues with the placement of the new tags. I've left comments with suggestions to align the formatting with other samples in the repository for better readability and maintainability.

@@ -21,7 +21,7 @@
*/

package search;

// [START retail_search_for_products_with_query_expansion_specification]
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 consistency with other samples in this repository (e.g., SearchSimpleQuery.java) and to improve readability, please add a blank line before and after the START region tag. This separates the package declaration, sample tag, and import statements.

The desired format is:

package search;

// [START retail_search_for_products_with_query_expansion_specification]

import com.google.cloud.ServiceOptions;

@@ -76,3 +76,4 @@ public static void searchResponse(String defaultSearchPlacementName) throws IOEx
}
}
}
// [END retail_search_for_products_with_query_expansion_specification]
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 better readability, please add a blank line before this END region tag. This helps to visually separate the code from the sample metadata tags.

For example:

  }
}

// [END retail_search_for_products_with_query_expansion_specification]

@glasnt glasnt assigned glasnt and unassigned chenlei1216 Jul 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: retail Issues related to the Retail API API. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants