summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAarni Koskela <akx@iki.fi>2023-02-22 21:05:19 +0200
committerGitHub <noreply@github.com>2023-02-22 14:05:19 -0500
commitaaf68b7f98df7f886778395112267b9b0f6140bc (patch)
treee3018d900501d9494a920970212ec2927a092d8d
parentf84623225e0227adde48ffd8f2e1cafb1f9aa38d (diff)
downloaddocker-py-aaf68b7f98df7f886778395112267b9b0f6140bc.tar.gz
api: note the data arg may also be a stream in `put_archive` (#2478)
Signed-off-by: Aarni Koskela <akx@iki.fi>
-rw-r--r--docker/api/container.py2
-rw-r--r--docker/models/containers.py2
2 files changed, 2 insertions, 2 deletions
diff --git a/docker/api/container.py b/docker/api/container.py
index 82a8922..9a25b21 100644
--- a/docker/api/container.py
+++ b/docker/api/container.py
@@ -966,7 +966,7 @@ class ContainerApiMixin:
container (str): The container where the file(s) will be extracted
path (str): Path inside the container where the file(s) will be
extracted. Must exist.
- data (bytes): tar data to be extracted
+ data (bytes or stream): tar data to be extracted
Returns:
(bool): True if the call succeeds.
diff --git a/docker/models/containers.py b/docker/models/containers.py
index c718bbe..f451cf3 100644
--- a/docker/models/containers.py
+++ b/docker/models/containers.py
@@ -324,7 +324,7 @@ class Container(Model):
Args:
path (str): Path inside the container where the file(s) will be
extracted. Must exist.
- data (bytes): tar data to be extracted
+ data (bytes or stream): tar data to be extracted
Returns:
(bool): True if the call succeeds.