Fix error handling documentation in README file #59
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
This documentation erroneously states that the gem will raise Faraday errors, but this hasn't been true for some time. In 2.9.0 it raised subclasses of Onfido::OnfidoError, and now in 3.x it raises Onfido::ApiError. As well as the type being different, the Onfido::ApiError does not include accessors for the type or fields as specified.
dvacca-onfido
approved these changes
Jul 17, 2024
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.
This documentation erroneously states that the gem will raise Faraday errors, but this hasn't been true for some time. In 2.9.0 it raised subclasses of Onfido::OnfidoError, and now in 3.x it raises Onfido::ApiError.
As well as the type being different, the Onfido::ApiError does not include accessors for the type or fields as specified.