feat: Expose structured API response errors #531
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nieomylnieja
requested review from
skrolikiewicz and
daniel-zelazny
as code owners
nieomylnieja
changed the title
# Conflicts: # sdk/config_activity.png
nieomylnieja
force-pushed
the
improve-http-errors
branch
from
ade14a4
to
d85a551
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
sdk.Clientmethods which interact with Nobl9 API currently return only generic text based errors.This obstructs the relevant details from the user. Furthermore, the current default text format for these errors is fairly poor and doesn't contain details like endpoint path.
Summary
sdk.APIErrorwhich is a structured error that contains all the relevant API error details as well as produces an improved (over the previous state) text representation.Testing
Covered by both unit and end-to-end tests.
Release Notes
sdk.ClientAPI calls now can returnsdk.APIError, which is a structured error providing details of the error returned by Nobl9's API.