Repository navigation
feat!: preserve API error responses and expose Problem details - #295
Merged
Merged
Conversation
Expose typed Problem details and preserve error response context. Add focused regression coverage and concise integration examples. BREAKING CHANGE: API error variants now contain boxed ApiErrorResponse values. Read the payload through response.body when matching variants.
Represent interrupted response bodies separately from connection failures. Keep the received status and headers alongside the original cause for documented and unexpected errors.
Merge current main and regenerate reader and token methods with response-aware API errors and typed Problem access.
Keep typed Problem access available when an endpoint does not describe its error body. Simplify the README and API documentation around the common error handling path.
This file contains hidden or 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
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.
API failures now retain their HTTP status, headers, and original response bytes alongside typed bodies.
error.problem()provides typed Problem details for documented and unrecognized Problem responses, including endpoints that do not describe their error body.Malformed documented error bodies remain HTTP failures with their original bytes instead of becoming network errors. Resource calls and event-object fetching share this behavior. If reading the body fails, status and headers remain available and the original error is retained as the cause.
Compatibility: Body-read failures now use
SdkError::Responseinstead ofSdkError::Network; exhaustive matches need to handle this variant.SdkError::Api(response)andSdkError::Unexpected(response)now contain a boxedApiErrorResponse. When matching either variant, read its typed or fallback payload throughresponse.body. Existingbody()andinto_body()helpers continue to expose the endpoint-specific body. The oldapiandunexpectedconstructors are replaced by the response-aware construction paths.The new reader and token endpoints on current main use the same error handling.
The README shows the common error handling path beside SDK usage, with access to the original response for other error details.
Related to sumup/sumup-py#434 and the Python SDK changes in sumup/sumup-py#436.