Skip to content

Commit

Permalink
Merge pull request #59 from Tabby/update-readme-error-handling
Browse files Browse the repository at this point in the history
Fix error handling documentation in README file
  • Loading branch information
dvacca-onfido authored Jul 17, 2024
2 parents a7be1f6 + bb2e584 commit 1b57823
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,20 @@ Documentation and code examples can be found at https://documentation.onfido.com

## Error Handling

All errors are wrapped by `ApiError` coming from [FaradayExpection](https://www.rubydoc.info/github/lostisland/faraday/Faraday/ClientError):
All errors are wrapped by `ApiError` coming from [FaradayException](https://www.rubydoc.info/github/lostisland/faraday/Faraday/ClientError):

- `Connection timed out` is raised in case of `Faraday::TimeoutError`
- `Connection failed` is raised in case of `Faraday::ConnectionFailed`

All errors provide the `response_code`, `response_body`, `json_body`, `type` and `fields` of the error.
All errors provide the `code`, `response_headers`, and `response_body` of the error.

```ruby
def create_applicant
onfido_api.create_applicant(params)
rescue Faraday::ConnectionFailed => e
e.type # => 'validation_error'
e.fields # => { "email": { "messages": ["invalid format"] } }
e.response_code # => '422'
rescue Onfido::ApiError => e
e.message # => 'Unprocessable entity'
e.response_body # => { error: { type: "validation_error", message: "", fields: { "email": [ "invalid format" ] } } }
e.code # => '422'
end
```

Expand Down

0 comments on commit 1b57823

Please sign in to comment.