Documentation for nodejs getMetadata doesn't indicate all options #2718
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.
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.
The text was updated successfully, but these errors were encountered: