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

Readme has incorrect info re: API keys #8081

Open
arsduo opened this issue Jan 14, 2022 · 0 comments
Open

Readme has incorrect info re: API keys #8081

arsduo opened this issue Jan 14, 2022 · 0 comments
Labels
type: docs Improvement to the documentation for an API.

Comments

@arsduo
Copy link

arsduo commented Jan 14, 2022

Hi! Hope you're all doing well after these two difficult years. Just want to note a small possible issue I found with the readme here.

The readme notes that this library offers integration with the googleauth gem for authentication using OAuth, API keys, and service accounts. However, after much experimentation, it seems like the (only) way to use an API key is directly through the service -- for instance

service = Google::Apis::YoutubeV3::YouTubeService.new
service.key = my_api_key

Just want to suggest updating the readme to make that clear for future developers looking to make API calls to resources that support API key authorization. (Might also be worth making a note about the need to include a referer and configure that on the API key, since that took some time to figure out as well.)

Thanks!

@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Jan 15, 2022
@bajajneha27 bajajneha27 added type: docs Improvement to the documentation for an API. and removed triage me I really want to be triaged. labels Jan 20, 2022
@yoshi-automation yoshi-automation removed the 🚨 This issue needs some love. label Jan 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

3 participants