Skip to content

fix(parametermanager): fix examples in parameter manager docs sample #13489

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

Conversation

durgesh-ninave-crest
Copy link
Contributor

Description

Fixed the examples in the Parameter Manager samples.

Checklist

@durgesh-ninave-crest durgesh-ninave-crest requested review from a team as code owners July 8, 2025 05:26
@product-auto-label product-auto-label bot added api: parametermanager samples Issues that are directly related to samples. labels Jul 8, 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 @durgesh-ninave-crest, 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 focuses on improving the accuracy and consistency of example code snippets within the Parameter Manager documentation. The changes address minor but important discrepancies in resource paths and parameter naming conventions, ensuring that the provided examples are correct and align with best practices for both global and regional Parameter Manager operations.

Highlights

  • Example Path Correction: Corrected the resource path for secret versions in create_param_version_with_secret.py and create_regional_param_version_with_secret.py examples, changing version/latest to versions/latest to reflect the correct plural form.
  • Example Parameter Consistency: Updated example parameter names in regional samples (remove_regional_param_kms_key.py and update_regional_param_kms_key.py) from my-global-parameter to my-regional-parameter to ensure consistency with the regional context of the snippets.
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 fixes incorrect examples in the Parameter Manager documentation samples. The changes correct a resource path for Secret Manager and use more consistent parameter names in regional examples. I've identified a high-severity issue where a multi-line string in an example creates an invalid resource path and have provided a suggestion for a fix. The other changes are correct and improve the quality of the samples.

Comment on lines 55 to 56
"projects/my-project/locations/us-central1/
secrets/application-secret/version/latest"
secrets/application-secret/versions/latest"
Copy link
Contributor

Choose a reason for hiding this comment

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

high

The secret_id string is split across two lines. This creates a single string literal containing a newline character and leading whitespace, which results in an invalid resource name. To ensure the example is correct and functional, use adjacent string literal concatenation to create a valid resource path and improve readability.

Suggested change
"projects/my-project/locations/us-central1/
secrets/application-secret/version/latest"
secrets/application-secret/versions/latest"
"projects/my-project/locations/us-central1/"
"secrets/application-secret/versions/latest"

@@ -42,7 +42,7 @@ def update_regional_param_kms_key(
update_regional_param_kms_key(
"my-project",
"us-central1",
"my-global-parameter",
"my-regional-parameter",
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The parameter ID in this example should be my-regional-parameter to align with the function's purpose of updating the KMS key for a regional parameter.

Suggested change
"my-regional-parameter",
"my-regional-parameter"

@gptSanyam gptSanyam added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 9, 2025
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: parametermanager samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants