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

Feature/api usage ui documentation #524

Merged
merged 24 commits into from
Oct 9, 2015

Conversation

brylie
Copy link
Contributor

@brylie brylie commented Oct 9, 2015

This pull request improves the usability for API backends by:

  • Adding navigation link to API page from Catalogue view
  • Displaying help text instructing user how to call API Umbrella

@brylie
Copy link
Contributor Author

brylie commented Oct 9, 2015

@apinf/developers please review ASAP, as this may be needed by the hackathon participants over the weekend. If this gets merged in time, it also needs to be deployed prior to the hackathon.

@ccsr please follow up.

@bajiat
Copy link
Contributor

bajiat commented Oct 9, 2015

@mauriciovieira Can you review the PR? I understood that you have been discussing this with Brylie in IRC.
@elnzv If the code is ok and this is merged, would you be able to deploy it before tomorrow?

@brylie
Copy link
Contributor Author

brylie commented Oct 9, 2015

It is a quick usability fix for people to figure out how to work with a given API backend. The two main pages that have been modified are:

  • API Catalogue now has links to individual API Backend pages
  • API Backend page now has button (in upper right) that toggles a help box

There are sub-templates for the buttons and help box.

I also had to create a server method to get the API Umbrella base URL, since it is stored in a private setting.

Additional changes include a fix to the linter file.

@ccsr
Copy link
Member

ccsr commented Oct 9, 2015

@mauriciovieira could you please review it and if everything is ok then please indicate to @elnzv so that he can go forward with the deployment

mauriciovieira added a commit that referenced this pull request Oct 9, 2015
@mauriciovieira mauriciovieira merged commit 8fba127 into develop Oct 9, 2015
@mauriciovieira
Copy link
Contributor

Sounds good! 👍

@mauriciovieira mauriciovieira deleted the feature/api-usage-ui-documentation branch October 9, 2015 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants