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

Improve communication of API status issues to external/internal users #3109

Closed
4 tasks done
Tracked by #137
dorothyyeager opened this issue Aug 13, 2019 · 4 comments
Closed
4 tasks done
Tracked by #137
Assignees

Comments

@dorothyyeager
Copy link
Contributor

dorothyyeager commented Aug 13, 2019

What we are after

Need to come up with a way to alert users to API status issues. This might be best accomplished by improving the message for our 500 errors, so that users are given more information than "server error."

Related issues

#966 - Original implementation issue

To do

@dorothyyeager dorothyyeager added this to the PI 9 innovation milestone Aug 13, 2019
@dorothyyeager dorothyyeager self-assigned this Aug 13, 2019
@AmyKort AmyKort changed the title Decide how/when to communicate API status issues to external/internal users Improve communication of API status issues to external/internal users Aug 13, 2019
@dorothyyeager
Copy link
Contributor Author

dorothyyeager commented Aug 14, 2019

I've made a first stab at drafting a new message and sent to @AmyKort @patphongs @PaulClark2 for their thoughts. In doing this, I looked at our revised 404 error message in #2675 plus worked in our discussion about the API status pingdom page. We'll need someone with access to change the URL in pingdom for that page.

Once we finalize the draft, we can send it around for a high level review as needed.

@dorothyyeager
Copy link
Contributor Author

For reference, here's the current message.

thumbnail_image001

@dorothyyeager
Copy link
Contributor Author

@PaulClark2 and @AmyKort have signed off on the draft message. We'll see if we need to run it any higher. We've also changed the pingdom URL to http://status.fec.gov/x0blqgj29ogg.

@dorothyyeager
Copy link
Contributor Author

The message has been drafted and approved, so we're ready to move on to implementation ticket.
That work will happen in #3113 .

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

1 participant