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

Document, homogenize, and improve error responses and JSON Schema Validation messages #185

Closed
2 tasks
aeneasr opened this issue Jan 27, 2020 · 3 comments
Closed
2 tasks
Labels
bug Something is not working. feat New feature or request.

Comments

@aeneasr
Copy link
Member

aeneasr commented Jan 27, 2020

Is your feature request related to a problem? Please describe.

We are currently lacking a consistent error strategy and need to homogenize payloads, document error types and their contexts, and so on. This makes several things hard:

  • Identifying validation error messages (currently we use the HTTP status code...)
  • Translating validation error messages. This would probably require a context object to e.g. identify a number: Your username must be longer than X characters

Additional context

Add any other context or screenshots about the feature request here.

@aeneasr aeneasr added bug Something is not working. feat New feature or request. module:docs labels Jan 27, 2020
@aeneasr aeneasr added this to the v0.1.1-alpha.1 milestone Jan 27, 2020
@aeneasr aeneasr changed the title Document, homogenize, and improve error responses Document, homogenize, and improve error responses and JSON Schema Validation messages Jan 27, 2020
@aeneasr aeneasr added this to To do in Maintainer's Board via automation Feb 3, 2020
@aeneasr
Copy link
Member Author

aeneasr commented May 27, 2020

It would probably be good if we have an iota for all errors, making breaking changes unlikely.

@aeneasr
Copy link
Member Author

aeneasr commented May 27, 2020

Make error IDs an array so that breaking changes are not as bad because one can use the legacy error code. This might happen when more specificity is added.

@aeneasr
Copy link
Member Author

aeneasr commented Jun 8, 2020

Resolved - more or less - on master. Still needs improvement but this can be done incrementally for each request. I think as soon as people complain about this we can point them to the right files to fix it.

@aeneasr aeneasr closed this as completed Jun 8, 2020
Maintainer's Board automation moved this from To do to Done Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something is not working. feat New feature or request.
Projects
Development

No branches or pull requests

1 participant