Skip to content

Commit d60ea8f

Browse files
committed
Add documentation.
1 parent daebf5f commit d60ea8f

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

docs/changelog.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1+
## v2.6.0
2+
3+
General
4+
* (Minor) Add ability to add request kwargs when initializing the client. These will be used when registering the client, fetching feature flags, and sending metrics.
5+
16
## v2.5.0
27

38
**General**
4-
* (Minor) Unleash client will not error if cache is not present and Unleash server not accessible during initialization..
9+
* (Minor) Unleash client will not error if cache is not present and Unleash server not accessible during initialization.
510

611
## v2.4.0
712

docs/unleashclient.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ metrics_interval | How often the unleash client should send metrics to server. |
1919
disable_metrics | Disables sending metrics to Unleash server. | N | Boolean | F |
2020
disable_registration | Disables registration with Unleash server. | N | Boolean | F |
2121
custom_headers | Custom headers to send to Unleash. | N | Dictionary | {}
22+
custom_options | Custom arguments for requests package. | N | Dictionary | {}
2223
custom_strategies | Custom strategies you'd like UnleashClient to support. | N | Dictionary | {} |
2324
cache_directory | Location of the cache directory. When unset, FCache will determine the location | N | Str | Unset |
2425

@@ -71,3 +72,18 @@ my_client = UnleashClient(
7172
disable_registration=True
7273
)
7374
```
75+
76+
**Overriding SSL certificate verification**
77+
78+
(Do this at your own risk!)
79+
80+
If using an on-prem SSL certificate with a self-signed cert, you can pass custom arguments through to the **request** package using the *custom_options* argument.
81+
82+
```python
83+
my_client = UnleashClient(
84+
url="https://myunleash.hamster.com",
85+
app_name="myClient1",
86+
instance_id="myinstanceid",
87+
custom_options={"verify": False}
88+
)
89+
```

0 commit comments

Comments
 (0)