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

Enhance usage instructions for API #758

Closed
bajiat opened this issue Jan 12, 2016 · 4 comments
Closed

Enhance usage instructions for API #758

bajiat opened this issue Jan 12, 2016 · 4 comments

Comments

@bajiat
Copy link
Contributor

bajiat commented Jan 12, 2016

In the View API backend page, there is a "View usage instructions" button. Pressing the button opens the following instructions:

"Make API calls to:
[automatically filled request URL]

Note: you may need to use your API Key, found on your profile page."

Based on feedback through the APIKA support channel, there is a need to enhance these instructions.

Optimally, the instructions should include the parameter of using API key (api_key) in the request coupled with the user's actual API key.
As a minimum, the instruction could include how to use API key in request (i.e. the parameter api_key).

Refer also to bug report #606.

@saralavanip
Copy link
Contributor

Verified on latest develop version.
Still have issue while calling API. Usage instructions could be more explanatory, providing URL that includes user API key.

Reported bugs:
https://github.com/apinf/api-umbrella-dashboard/issues/606
https://github.com/apinf/api-umbrella-dashboard/issues/758

@bajiat
Copy link
Contributor Author

bajiat commented Jan 25, 2016

@frenchbread Will you take this task? Brylie can give you some guidance, if needed.

@frenchbread
Copy link
Contributor

@bajiat Self-assigned

@frenchbread
Copy link
Contributor

PR #801.
Looks like:
screen shot 2016-01-27 at 10 27 25

@brylie brylie closed this as completed in 4dcdc2e Jan 27, 2016
@bajiat bajiat added this to the Sprint 21 milestone Jan 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants