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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃捇 [API] Generalise error response #264

Open
1 of 2 tasks
neel1996 opened this issue Nov 4, 2022 · 0 comments
Open
1 of 2 tasks

馃捇 [API] Generalise error response #264

neel1996 opened this issue Nov 4, 2022 · 0 comments
Assignees
Labels
area/api Mimock APIs type/enhancement New feature or request

Comments

@neel1996
Copy link
Member

neel1996 commented Nov 4, 2022

Summary

The error response sent from the API is currently not following a common model. This will become a challenge to contextualise the error message or notifications shown to the user in the UI.

A common error response model needs to be introduced to pass an unique code for the error and a message describing the error to the user

Scope of the issue

To introduce a new error response model and use it across the existing controllers

Proposed model

{
    errorCode: "MOCK_IS_DUPLICATE",
    errorMessage: "The mock you are trying to add already exists"
}

Impacted area

  • UI
  • Backend

Supporting artifacts

No response

@neel1996 neel1996 added type/enhancement New feature or request area/api Mimock APIs labels Nov 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Mimock APIs type/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants