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

[EPIC] fix: error handling in REST API endpoints #1378

Open
petermetz opened this issue Sep 24, 2021 · 0 comments
Open

[EPIC] fix: error handling in REST API endpoints #1378

petermetz opened this issue Sep 24, 2021 · 0 comments
Labels
API_Server bug Something isn't working Core_API Changes related to the Core API Package Developer_Experience documentation Improvements or additions to documentation Epic good-first-issue Good for newcomers good-first-issue-400-expert Hacktoberfest Hacktoberfest participants are welcome to take a stab at issues marked with this label.

Comments

@petermetz
Copy link
Member

petermetz commented Sep 24, 2021

Description

4xx and 5xx status codes should be used correctly throughout the codebase.
Right now there are instances where an exception thrown is hardcoded to lead to an HTTP 400 regardless of what the exception was.
We need to untangle on a case by case basis the issue above because in some cases the plugins throw exceptions that are user error related.

There should be documentation about error handling and with a decision tree where contributors can ask themselves a series of questions to determine what is the appropriate way of handling an error.

Acceptance Criteria

  1. User error vs. internal server error is always clearly distinguished vs. it being basically random (which right now it is in some endpoints)
  2. Collect a list of sub-issues (which are for the implementation work) into this epic
@petermetz petermetz added API_Server bug Something isn't working Core_API Changes related to the Core API Package Developer_Experience documentation Improvements or additions to documentation good-first-issue Good for newcomers good-first-issue-400-expert Hacktoberfest Hacktoberfest participants are welcome to take a stab at issues marked with this label. Epic labels Sep 24, 2021
@petermetz petermetz changed the title fix: error handling in REST API endpoints [EPIC] fix: error handling in REST API endpoints Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API_Server bug Something isn't working Core_API Changes related to the Core API Package Developer_Experience documentation Improvements or additions to documentation Epic good-first-issue Good for newcomers good-first-issue-400-expert Hacktoberfest Hacktoberfest participants are welcome to take a stab at issues marked with this label.
Projects
None yet
Development

No branches or pull requests

1 participant