New issue
Advanced search Search tips
Note: Color blocks (like or ) mean that a user may not be available. Tooltip shows the reason.

Issue 626331 link

Starred by 2 users

Issue metadata

Status: Untriaged
Owner: ----
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: Windows
Pri: 2
Type: Bug



Sign in to add a comment

API key documentation not correct

Reported by willem.m...@gmail.com, Jul 7 2016

Issue description

UserAgent: Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2784.0 Safari/537.36

Steps to reproduce the problem:
Read the documentation on adding API keys to Chromium:

http://www.chromium.org/developers/how-tos/api-keys

This issue is about "Acquiring Keys - step 6", where the list of API's is with text a description on how to use them. I have a suggestion for changing this description.

What is the expected behavior?

What went wrong?
The documentation suggests all APIs listed are necessary while they are not.

It contains a huge list of API's you need to subscribe to for Chromium to work, however, it is completely optional to subscribe to (all) the API's in the list, you only need specific API's for specific related functionalities.

Personally I only got API keys to use Sync (and to be rid of the error message I otherwise get at startup, warning me I don't have API keys), so I made a key/id/secret combination and enabled the sync API, and Chromium works fine now. The 'missing API keys' warning disappeared and sync works.

I suggest this documentation is changed to reflect this.

Did this work before? No 

Chrome version:   Channel: n/a
OS Version: 
Flash Version: 

The text above the list of API's currently is:

In the 'APIs & auth' > APIs tab -> API Library tab, search for all of the following APIs. If you're a member of the chromeos-dev Google group you should see all of them. For each of these APIs click on them when found by the search, and then click on "Enable API" button at the top, read and agree to the Terms of Service that is shown, check the "I have read and agree to <API name> Terms of Service" checkbox and click Accept: 
(This list might be out of date; try searching for APIs starting with "Chrome" or having "for Chrome" in the name.)

I suggest this is changed to something like:

In the 'APIs & auth' > APIs tab -> API Library tab, search for the following APIs. You only have to enable the APIs you'll actually use, i.e. if you don't use Chromium's translation functionality you don't need to enable the Chrome Translate Element API.
If you're a member of the chromeos-dev Google group you should see all of them.
For each of the APIs you want to enable, click on them when found by the search, and then click on "Enable API" button at the top, read and agree to the Terms of Service that is shown, check the "I have read and agree to <API name> Terms of Service" checkbox and click Accept:
(This list might be out of date; try searching for APIs starting with "Chrome" or having "for Chrome" in the name.)
 

Comment 1 by ajha@chromium.org, Jul 12 2016

Labels: Documentation
Cc: ajha@chromium.org rnimmagadda@chromium.org
Components: Infra>Documentation
Status: Untriaged (was: Unconfirmed)
Could someone from the Documentation Dev team please look into this issue.

Thank you.
Status: Available (was: Untriaged)
Project Member

Comment 4 by sheriffbot@chromium.org, Sep 4 2017

Labels: Hotlist-Recharge-Cold
Status: Untriaged (was: Available)
This issue has been Available for over a year. If it's no longer important or seems unlikely to be fixed, please consider closing it out. If it is important, please re-triage the issue.

Sorry for the inconvenience if the bug really should have been left as Available. If you change it back, also remove the "Hotlist-Recharge-Cold" label.

For more details visit https://www.chromium.org/issue-tracking/autotriage - Your friendly Sheriffbot

Sign in to add a comment