docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'api-docs-update'

This commit is contained in:
Joffrey F 2016-10-05 11:21:31 -07:00
parent f52203601b b22e390e56
commit 531fdc77e8
1 changed files with 23 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/api.md
View File

@ -19,33 +19,6 @@ is hosted.
* user_agent (str): Set a custom user agent for requests to the server.
## Version mismatch
You may encounter an error like this:
```text
client is newer than server (client API version: 1.24, server API version: 1.23)
```
To fix this, you have to either supply exact version to `Client` which you know that server supports:
```python
client = docker.Client(version="1.23")
```
or let client pick the newest version server supports:
```python
client = docker.Client(version="auto")
```
or even
```python
client = docker.AutoVersionClient()
```
****
## attach
@ -1231,3 +1204,26 @@ TODO:
* load_image
-->
****
## Version mismatch
You may encounter an error like this:
```text
client is newer than server (client API version: 1.24, server API version: 1.23)
```
To fix this, you have to either supply the exact version your server supports
when instantiating the `Client`:
```python
client = docker.Client(version="1.23")
```
or let the client automatically detect the newest version server supports:
```python
client = docker.Client(version="auto")
```