Skip to content

docs: demonstrate various usage of credentials loading#2123

Closed
lirantal wants to merge 2 commits intogoogleapis:mainfrom
lirantal:patch-1
Closed

docs: demonstrate various usage of credentials loading#2123
lirantal wants to merge 2 commits intogoogleapis:mainfrom
lirantal:patch-1

Conversation

@lirantal
Copy link
Contributor

@lirantal lirantal commented Dec 20, 2022

The following README.md file changes introduce documentation updates to help users learn on different ways they can load the service account key file's contents into the Storage constructor.

The documentation was updated to include:

  1. Loading the credentials as a string from an environment variable
  2. Specifying the credentials directly within JavaScript by providing the object

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #2122 🦕

The following README.md file changes introduce documentation updates to help users learn on different ways they can load the service account key file's contents into the `Storage` constructor.

The documentation was updated to include:
1. Loading the credentials as a string from an environment variable
2. Specifying the credentials directly within JavaScript by providing the object
@lirantal lirantal requested a review from a team as a code owner December 20, 2022 08:10
@lirantal lirantal requested a review from a team December 20, 2022 08:10
@generated-files-bot
Copy link

Warning: This pull request is touching the following templated files:

@product-auto-label product-auto-label bot added size: m Pull request size is medium. api: storage Issues related to the googleapis/nodejs-storage API. labels Dec 20, 2022
@lirantal
Copy link
Contributor Author

Based on the comment bot above it looks like the changes need to be placed elsewhere? happy to make changes to help get this landed.

lirantal added a commit to lirantal/nodejs-storage that referenced this pull request Dec 21, 2022
This is a follow-up to PR googleapis#2123 in hope to address both README.md elaborate documentation updates as well as in-code documentation
shaffeeullah pushed a commit that referenced this pull request Dec 27, 2022
…2124)

This is a follow-up to PR #2123 in hope to address both README.md elaborate documentation updates as well as in-code documentation
@shaffeeullah
Copy link
Contributor

There is consensus that the new API level documentation should help this problem significantly. If people are still struggling with this, please comment and let us know and we'll think about what else we can do! Thanks for your help improving the documentation here :)

@dwang-qm
Copy link

There is consensus that the new API level documentation should help this problem significantly.

Where is this documentation? Can a link be provided? It's still unreasonably challenging to find out how to authenticate with anything except ADC for all of Google's NodeJS packages.

sofisl pushed a commit to googleapis/google-cloud-node that referenced this pull request Feb 25, 2026
…2124)

This is a follow-up to PR googleapis/nodejs-storage#2123 in hope to address both README.md elaborate documentation updates as well as in-code documentation
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 googleapis/nodejs-storage API. size: m Pull request size is medium.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing docs: Can we update the documentation with regards to JSON credentials loading *not* from a file reference?

3 participants