diff options
author | Joffrey F <joffrey@docker.com> | 2016-10-05 11:21:31 -0700 |
---|---|---|
committer | Joffrey F <joffrey@docker.com> | 2016-10-05 11:21:31 -0700 |
commit | 531fdc77e86d3e17ce8ea1e8397ce332e5d414d4 (patch) | |
tree | a3f6e6e0013798abf337692510bd69b086d97870 | |
parent | f52203601b5cf3d8979852484889267279f95c9c (diff) | |
parent | b22e390e568280274f702738abc0976caf3c5801 (diff) | |
download | docker-py-531fdc77e86d3e17ce8ea1e8397ce332e5d414d4.tar.gz |
Merge branch 'api-docs-update'
-rw-r--r-- | docs/api.md | 50 |
1 files changed, 23 insertions, 27 deletions
diff --git a/docs/api.md b/docs/api.md index 738606d..affbaac 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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") +``` |