Skip to content

docs(storage): improve signed url builder docs#4197

Merged
alvarowolfx merged 6 commits intogoogleapis:mainfrom
alvarowolfx:docs-gcs-signed-url
Jan 9, 2026
Merged

docs(storage): improve signed url builder docs#4197
alvarowolfx merged 6 commits intogoogleapis:mainfrom
alvarowolfx:docs-gcs-signed-url

Conversation

@alvarowolfx
Copy link
Copy Markdown
Collaborator

@alvarowolfx alvarowolfx commented Jan 9, 2026

Improvements to SignedUrlBuilder docs:

  • Hide use google_cloud_storage::builder::storage::SignedUrlBuilder
  • Add warning about using Service Account
  • Point to the http:Method::GET on with_method
  • Show signed url generation examples before Signer examples
  • Document the behavior of with_header and with_query_param that they override value if same key is set
  • Link to what is ADC.
  • Show wrapper func on examples so developer knows where the signer comes from

Towards #3645

@alvarowolfx alvarowolfx requested a review from a team January 9, 2026 02:47
@product-auto-label product-auto-label bot added the api: storage Issues related to the Cloud Storage API. label Jan 9, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.77%. Comparing base (de1bb71) to head (54bcf10).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4197      +/-   ##
==========================================
+ Coverage   94.76%   94.77%   +0.01%     
==========================================
  Files         187      187              
  Lines        7106     7106              
==========================================
+ Hits         6734     6735       +1     
+ Misses        372      371       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

coryan
coryan previously approved these changes Jan 9, 2026
Copy link
Copy Markdown
Collaborator

@coryan coryan left a comment

Choose a reason for hiding this comment

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

A few nits.

@alvarowolfx alvarowolfx merged commit eeb8360 into googleapis:main Jan 9, 2026
30 checks passed
ldetmer pushed a commit to ldetmer/google-cloud-rust that referenced this pull request Jan 9, 2026
Improvements to SignedUrlBuilder docs:
* Hide use google_cloud_storage::builder::storage::SignedUrlBuilder
* Add warning about using Service Account
* Point to the `http:Method::GET` on `with_method`
* Show signed url generation examples before Signer examples
* Document the behavior of `with_header` and `with_query_param` that
they override value if same key is set
* Link to what is ADC.
* Show wrapper func on examples so developer knows where the `signer`
comes from


Towards googleapis#3645
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: storage Issues related to the Cloud Storage API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants