Skip to content

Commit

Permalink
Added raise_on_unexpected_status to user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ckunki committed Apr 18, 2024
1 parent 5192ab3 commit 98ef8a4
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions doc/user_guide/user-guide.md
Original file line number Diff line number Diff line change
@@ -1 +1,14 @@
# SaaS API for Python User Guide

## Raise Error on Response Status Code Other Than 200

The default behavior of the API client is to return a response with a status code and optionally an attribute `parsed` containing the returned data.

If you want the client to raise an exception for each response with a status other than 200 then please provide optional keyword argument `raise_on_unexpected_status=True`:

```python
from exasol.saas.client.openapi.api.databases import list_databases

client = AuthenticatedClient(host, token, raise_on_unexpected_status=True)
databases = list_databases.sync(client)
````

0 comments on commit 98ef8a4

Please sign in to comment.