Skip to content

Commit 1e9a40b

Browse files
committed
regenerated end_to_end_tests README
1 parent 2305f6e commit 1e9a40b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

end_to_end_tests/golden-record/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,25 @@ my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
4141
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
4242
```
4343

44+
By default when you're calling an https api it will attempt to verify that ssl is working correctly.
45+
Using certificate verification is highly recommended most of the time and is the default.
46+
But sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
47+
48+
```python
49+
client = AuthenticatedClient(base_url="https://internal_api.example.com",
50+
token="SuperSecretToken",
51+
verify_ssl='/path/to/certificate_bundle.pem')
52+
```
53+
54+
or even disable ssl verification altogether, despite the fact that it can cause security risks.
55+
56+
```python
57+
client = AuthenticatedClient(base_url="https://internal_api.example.com",
58+
token="SuperSecretToken",
59+
verify_ssl=False)
60+
```
61+
but be careful with it.
62+
4463
Things to know:
4564
1. Every path/method combo becomes a Python module with four functions:
4665
1. `sync`: Blocking request that returns parsed data (if successful) or `None`

0 commit comments

Comments
 (0)