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

Return reason for errors in REST API #54

Closed
pablochacin opened this issue Nov 15, 2024 · 1 comment
Closed

Return reason for errors in REST API #54

pablochacin opened this issue Nov 15, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@pablochacin
Copy link
Collaborator

pablochacin commented Nov 15, 2024

When a call to the build service fails, the client gets a response with an Error field containing the description of the error.
As there may be multiple sources for the error, it would be convenient to categorize errors as related to the requirements from those related to the build service itself, and complement with a detailed reason for this error.

For example,
Error: "could not satisfy dependency", Reason: "unknown dependency"
Error: "build failed", Reason: "build timeout".

The API client library can wrap the reason into the build service error to allow its users to unwrap it.

@pablochacin pablochacin self-assigned this Nov 15, 2024
@pablochacin pablochacin added the enhancement New feature or request label Nov 15, 2024
@pablochacin pablochacin changed the title Offer a reason for error in REST API Return reason for errors in REST API Nov 15, 2024
@pablochacin
Copy link
Collaborator Author

Closed by #61

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant