diff options
author | Joffrey F <joffrey@docker.com> | 2015-07-08 13:38:41 -0700 |
---|---|---|
committer | Joffrey F <joffrey@docker.com> | 2015-07-08 13:38:41 -0700 |
commit | 69ef9e5668254adf8c951571660b11d4c89b2529 (patch) | |
tree | 731b8a2228dcb4f02540635c71843a2bfc891547 | |
parent | 28d0840cac58172817465863709a295085fcbffd (diff) | |
download | docker-py-69ef9e5668254adf8c951571660b11d4c89b2529.tar.gz |
Added missing `Client.load_image` docs
Clarified `Client.wait` docs
-rw-r--r-- | docs/api.md | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/api.md b/docs/api.md index 5a3b322..f1e2d03 100644 --- a/docs/api.md +++ b/docs/api.md @@ -513,6 +513,15 @@ Kill a container or send a signal to a container * container (str): The container to kill * signal (str or int): The singal to send. Defaults to `SIGKILL` +## load_image + +Load an image that was previously saved using `Client.get_image` +(or `docker save`). Similar to `docker load`. + +**Params**: + +* data (binary): Image data to be loaded + ## login Nearly identical to the `docker login` command, but non-interactive. @@ -828,10 +837,13 @@ Nearly identical to the `docker version` command. ## wait Identical to the `docker wait` command. Block until a container stops, then -print its exit code. Returns the value `-1` if no `StatusCode` is returned by -the API. +return its exit code. Returns the value `-1` if the API responds without a +`StatusCode` attribute. -If `container` a dict, the `Id` key is used. +If `container` is a dict, the `Id` key is used. + +If the timeout value is exceeded, a `requests.exceptions.ReadTimeout` +exception will be raised. **Params**: |