Skip to content
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

Missing GetSignedUrlConfig type documentation #5847

Open
6 tasks done
yohanc3 opened this issue Nov 30, 2024 · 1 comment
Open
6 tasks done

Missing GetSignedUrlConfig type documentation #5847

yohanc3 opened this issue Nov 30, 2024 · 1 comment

Comments

@yohanc3
Copy link

yohanc3 commented Nov 30, 2024

Please make sure you have searched for information in the following guides.

Documentation Request

A few days ago I was working with GCP Storage (I was using typescript), and I was using signed urls to download/upload files, and I wanted to download files under a different name. I looked up if there was a way to do that by using this library only, and found some Stack Overflow threads pointing at passing contentDisposition to the config options in the getSignedUrl, I tried that but it did not work. Some comments said you could also append that header to the signed url, I did not try that.

It wasn't until I looked directly into thegetSignedUrlOptions type that I found responseDisposition, then thanks to the docs for the contentDisposition header I got to download files under a different name.

Is there a specific reason why getSignedUrlOptions isn't documented anywhere? I feel like it's important to at least have a rough description of the different config options you can pass into getSignedUrlOptions, or to have a url that points directly to the library's types the user should be aware of. I'd like to volunteer to write the docs for getSignedUrlOptions as well, unless an official supporter does it.

@sofisl
Copy link
Contributor

sofisl commented Dec 2, 2024

Are you referring to https://github.com/googleapis/nodejs-storage? Perhaps that question/library may be better there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants