Skip to content

docs: add guidance for using GetParameterVersion#14118

Merged
YashSaraf11 merged 1 commit intoGoogleCloudPlatform:mainfrom
amitmodak:update-get-param-doc
Apr 30, 2026
Merged

docs: add guidance for using GetParameterVersion#14118
YashSaraf11 merged 1 commit intoGoogleCloudPlatform:mainfrom
amitmodak:update-get-param-doc

Conversation

@amitmodak
Copy link
Copy Markdown
Contributor

Description

Fixes #

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

Checklist

@amitmodak amitmodak requested review from a team as code owners April 28, 2026 06:28
@product-auto-label product-auto-label Bot added the samples Issues that are directly related to samples. label Apr 28, 2026
Copy link
Copy Markdown
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 a documentation comment to the get_param_version function to clarify that it is intended for retrieving metadata rather than high-volume access. The review feedback suggests improving the comment's formatting by removing unnecessary blank lines and using the canonical cloud.google.com domain for the provided link.

Comment on lines +23 to +28

# The GetParameterVersion operation retrieves parameter metadata and doesn't
# support high-volume access. To access parameter values at scale,
# see Access a parameter version (https://docs.cloud.google.com/secret-manager/parameter-manager/docs/render-parameter-version).


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 added guidance comment is separated from the function by multiple blank lines, which reduces its clarity and association with the get_param_version function. Additionally, the URL should use the canonical cloud.google.com domain instead of docs.cloud.google.com.

Suggested change
# The GetParameterVersion operation retrieves parameter metadata and doesn't
# support high-volume access. To access parameter values at scale,
# see Access a parameter version (https://docs.cloud.google.com/secret-manager/parameter-manager/docs/render-parameter-version).
# The GetParameterVersion operation retrieves parameter metadata and doesn't
# support high-volume access. To access parameter values at scale,
# see Access a parameter version (https://cloud.google.com/secret-manager/parameter-manager/docs/render-parameter-version).

Copy link
Copy Markdown

@YashSaraf11 YashSaraf11 left a comment

Choose a reason for hiding this comment

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

nit: extra line added can be removed

@YashSaraf11 YashSaraf11 merged commit 5adb729 into GoogleCloudPlatform:main Apr 30, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

samples Issues that are directly related to samples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants