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

Address usability concerns on openFEC API swagger page #4565

Open
5 tasks
JonellaCulmer opened this issue Aug 17, 2020 · 2 comments
Open
5 tasks

Address usability concerns on openFEC API swagger page #4565

JonellaCulmer opened this issue Aug 17, 2020 · 2 comments

Comments

@JonellaCulmer
Copy link
Contributor

JonellaCulmer commented Aug 17, 2020

What we're after: We need to improve the usability of the swagger page. We've implemented language changes and the API key sign up form. While those were necessary and immediate changes to support the API, we need to now take another look at how the page functions.

openFEC API swagger page: https://api.open.fec.gov/developers/

Potential problems:

  • Form usability
  • Page usability
  • Ease of page navigation

Action items:

  • Document usability pain points and problems
  • Consider and mock-up improvements
  • For consideration: are our users benefitting by having the api key signup form embedded on our site? One pain point at the moment is that the form does not work on all browsers. Some users have reverted to using the link that was provided previously. This "action item" is meant to generate discussion from multiple viewpoints (added by @jason-upchurch) (resolved by reporting to api.data.gov)

Completion criteria:

  • Documented usability problems are addressed and mocked up for future implementation
  • Follow-up implementation ticket is opened
@johnnyporkchops
Copy link
Contributor

johnnyporkchops commented Aug 24, 2020

One enhancement is that this could be put into an accordion. Also a click event on the accordion could trigger the form load--possibly solving the concern for intermittent non-loading of form:

Also see Issue submitted on https://github.com/18F/api.data.gov/ here:
18F/api.data.gov#554

signup_accordion

@realimpat
Copy link

Hi,

I was looking to explore the API but the swagger page looks broken. I find it very hard to read, to the extent that I've been using the bulk data downloads instead, because I can navigate them.

Here is a screenshot.
Screen Shot 2020-08-30 at 6 23 36 PM

Is this what is supposed to show up? (live demo of open source swagger ui from swagger.io)
https://petstore.swagger.io/?_ga=2.253231433.192694618.1598826364-1119385499.1598826364&_gac=1.125568504.1598826364.CjwKCAjwnK36BRBVEiwAsMT8WKdMUROAaeKrC9W5uAKtxBP5XrMZVTWULkcLumoXtF5Y88Uxs0JTWRoCQhQQAvD_BwE

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

3 participants