Update fields to extract AuthAPIError messages #566
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
"message" does not appear to match the API -- it is never used.
"error" is a copy of "code" in some cases, but it is only used in the
top-level error wrapper (not the nested error doc we extract).
"title" *is* actively used as an alternative to "detail" and was not
being checked. Add this to the fields.
This can be refined further over time if we see issues with this
message parsing.
The change could technically be breaking for code which uses
`AuthAPIError.message` to drive logic. e.g.
try: ...
except AuthAPIError as e:
if "foostr" in e.message: ...
raise
However, we're improving behavior and staying consistent with the
spirit of semver. The above kind of logic presumably _should have
been_ written as
try: ...
except AuthAPIError as e:
if "foostr" in e.raw_text: ...
raise
sirosen
force-pushed
the
auth-errmessage-fields
branch
from
7589171
to
ab7e653
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.
"message" does not appear to match the API -- it is never used. "error" is a copy of "code" in some cases, but it is only used in the
top-level error wrapper (not the nested error doc we extract). "title" is actively used as an alternative to "detail" and was not being checked. Add this to the fields.
This can be refined further over time if we see issues with this message parsing.
The change could technically be breaking for code which uses
AuthAPIError.messageto drive logic. e.g.However, we're improving behavior and staying consistent with the spirit of semver. The above kind of logic presumably should have been written as