Skip to content

Commit 4024c30

Browse files
committed
Remove examples that disable ssl verification. Add links to api_wrapper docs.
1 parent a6f240b commit 4024c30

3 files changed

Lines changed: 16 additions & 4 deletions

File tree

docs/lineage.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,19 @@ The Lineage API response includes:
5555

5656
### Examples
5757

58+
The example below uses an `APIWrapper` instance to make its requests. See [api_wrapper.md](api_wrapper.md) for the
59+
full set of `APIWrapper` arguments, including how to configure the container path, context path, SSL, and
60+
authentication.
61+
5862
```python
5963
from collections import defaultdict
6064

6165
from labkey.api_wrapper import APIWrapper
6266
from labkey.query import QueryFilter
6367

64-
labkey_server = "localhost:8080"
68+
labkey_server = "www.example.com"
6569
container_path = "Tutorials/HIV Study" # Full project/folder container path
66-
api = APIWrapper(labkey_server, container_path, use_ssl=False)
70+
api = APIWrapper(labkey_server, container_path)
6771

6872
###################
6973
# Create a data class domain

docs/storage.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,17 @@ The specific set of props will differ for each storage item type:
2727

2828
### Examples
2929

30+
The example below uses an `APIWrapper` instance to make its requests. See [api_wrapper.md](api_wrapper.md) for the
31+
full set of `APIWrapper` arguments, including how to configure the container path, context path, SSL, and
32+
authentication.
33+
3034
```python
3135
from labkey.api_wrapper import APIWrapper
3236

33-
labkey_server = "localhost:8080"
37+
labkey_server = "www.example.com"
3438
container_path = 'Tutorials/HIV Study' # Full project/folder container path
3539
contextPath = "labkey"
36-
api = APIWrapper(labkey_server, container_path, contextPath, use_ssl=False)
40+
api = APIWrapper(labkey_server, container_path, contextPath)
3741

3842

3943
###############

docs/webdav.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Our Python API includes some convenience methods for creating "webdavclient3" clients, and building webdav file paths.
44

5+
The examples below use an `APIWrapper` instance to make their requests. See [api_wrapper.md](api_wrapper.md) for the
6+
full set of `APIWrapper` arguments, including how to configure the container path, context path, SSL, and
7+
authentication.
8+
59
### Creating a WebDav client
610
First, make sure you have the [webdavclient3](https://github.com/ezhov-evgeny/webdav-client-python-3) library installed:
711

0 commit comments

Comments
 (0)