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

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def create_param_version_with_secret(
"my-project",
"my-global-parameter",
"v1",
"projects/my-project/secrets/application-secret/version/latest"
"projects/my-project/secrets/application-secret/versions/latest"
)
"""
# Import the necessary library for Google Cloud Parameter Manager.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def create_regional_param_version_with_secret(
"my-regional-parameter",
"v1",
"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"

)
"""
# Import the necessary library for Google Cloud Parameter Manager.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def remove_regional_param_kms_key(
remove_regional_param_kms_key(
"my-project",
"us-central1",
"my-global-parameter"
"my-regional-parameter"
)
"""
# Import the necessary library for Google Cloud Parameter Manager.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"

"projects/my-project/locations/us-central1/keyRings/test/cryptoKeys/updated-test-key"
)
"""
Expand Down