Skip to content

Missing GetSignedUrlConfig type documentation #2567

Open
@yohanc3

Description

@yohanc3

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

Documentation Request

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    api: storageIssues related to the googleapis/nodejs-storage API.type: docsImprovement to the documentation for an API.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions