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

SEP0006: Make it clear that error responses should be strings #402

Closed
morleyzhi opened this issue Sep 16, 2019 · 0 comments · Fixed by #403
Closed

SEP0006: Make it clear that error responses should be strings #402

morleyzhi opened this issue Sep 16, 2019 · 0 comments · Fixed by #403
Assignees

Comments

@morleyzhi
Copy link
Contributor

/deposit and /withdraw endpoints sometimes return errors. The examples indicate that they should return a property error that's a string, but that's not made clear in the spec's language.

So my suggestion is:

  • Canonize the error response property, required for errors, and require that it be a string. It should be human-readable and user-friendly.
  • Add an optional error_metadata property that must be an object, and can contain more information about the error.
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 a pull request may close this issue.

2 participants