Skip to content

Instantly share code, notes, and snippets.

@owenkellogg

owenkellogg/gateway_errors_story.md

Created June 20, 2014 21:31
Show Gist options
  • Save owenkellogg/6fa13d556193c2a39f4e to your computer and use it in GitHub Desktop.
Save owenkellogg/6fa13d556193c2a39f4e to your computer and use it in GitHub Desktop.
Download ZIP
Gatewayd Errors Story
Raw
gateway_errors_story.md

Gatewayd is an HTTP / JSON API server that provides functionality enabling any user of the software to operate a Ripple Gateway. The REST interface is composed of nearly forty endpoints, for which the required parameters and successful responses are documented. However there are very few if any appropriate error messages returned to the API caller when an invalid request is made, or when gatewayd experiences a software exception.

  1. Enumerate all the various errors that can be returned from the Gatewayd API.

  2. Write mocha specs for the HTTP API that test error cases and assert properly formatted errors.

  3. Implement proper error generation in the API Core layer, and propagate the errors to the HTTP API layer.

Error reporting of Gatewayd with as much robustness as provided by the tasks listed will dramatically improve the experience for engineers creating integrations with Gatewayd and plugin modules for additional Gatewayd functionality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment