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

Documentation for nodejs getMetadata doesn't indicate all options #2718

Closed
tejohnso opened this issue Nov 2, 2017 · 1 comment
Closed

Documentation for nodejs getMetadata doesn't indicate all options #2718

tejohnso opened this issue Nov 2, 2017 · 1 comment
Assignees
Labels
api: storage Issues related to the Cloud Storage API. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@tejohnso
Copy link

tejohnso commented Nov 2, 2017

Looking for example at getMetadata there's an indication that userProject can be supplied as an option, but there's no indication that we can include any key and it is going to be passed to the underlying request package as part of the qs (querystring) configuration for the request.

So while getMetadata({userProject: true}) might work, getMetadata({fields: "generation"}) also works. This is a minor issue, but it would be nice if it was more clear that what we're really passing as configuration is any querystring value that should be included. Curious to know why userProject is singled out there.

Also, as an aside, the documentation indicates userProject is a boolean.

@stephenplusplus stephenplusplus added api: storage Issues related to the Cloud Storage API. docs type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Nov 2, 2017
@stephenplusplus
Copy link
Contributor

This issue was moved to googleapis/nodejs-storage#77

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. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

No branches or pull requests

2 participants