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

Implement new error structure in backend. #883

Closed
kgodey opened this issue Dec 12, 2021 · 5 comments · Fixed by #991
Closed

Implement new error structure in backend. #883

kgodey opened this issue Dec 12, 2021 · 5 comments · Fixed by #991
Assignees
Labels
affects: architecture Improvements or additions to architecture restricted: maintainers Only maintainers can resolve this issue type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL

Comments

@kgodey
Copy link
Contributor

kgodey commented Dec 12, 2021

Problem

We've agreed on a standard error structure for the API in #560. Now we need to implement it.

Proposed solution

I'll format these in terms of desired outcomes. Whoever works on this can feel free to split these up into separate issues if that's helpful.

  • All current API error responses should follow our error structure.
  • All error codes and their corresponding details fields are documented somewhere.
  • We have a standard way of generating new error codes.

Additional context

@kgodey kgodey added type: enhancement New feature or request affects: architecture Improvements or additions to architecture work: backend Related to Python, Django, and simple SQL ready Ready for implementation restricted: maintainers Only maintainers can resolve this issue labels Dec 12, 2021
@kgodey kgodey added this to the [08.1] 2022-01 improvements milestone Dec 12, 2021
@silentninja silentninja self-assigned this Dec 14, 2021
@silentninja silentninja added status: started and removed ready Ready for implementation labels Dec 14, 2021
@silentninja
Copy link
Contributor

silentninja commented Dec 14, 2021

I am planning to set up the necessary infrastructure so that it is easier to capture and define the error structure for the captured error. Which it be then followed by each error getting then own error structure(sub tasklist), where #859 will be the priority

@silentninja
Copy link
Contributor

Though we can complete this issue by fixing the returned error response, I think it would be better if #623 is completed before we make changes to the structure of the error response as it will be easier to organise and define them.

@kgodey
Copy link
Contributor Author

kgodey commented Dec 14, 2021

@silentninja That's fine. please make small and incremental PRs so that changes are easy to review and merge. Getting #859 done to unblock the frontend soon should be a priority, so please organize your work so that we get to that ASAP.

@silentninja
Copy link
Contributor

@kgodey I put together a meta issue #889 that composes all the requirements for error handling.

@kgodey
Copy link
Contributor Author

kgodey commented Dec 16, 2021

Thanks @silentninja

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects: architecture Improvements or additions to architecture restricted: maintainers Only maintainers can resolve this issue type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL
Projects
No open projects
2 participants