api: note the data arg may also be a stream in put_archive (#2478)

Signed-off-by: Aarni Koskela <akx@iki.fi>
docker · Feb 22, 2023 · aaf68b7 · aaf68b7
1 parent f846232
commit aaf68b7
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docker/api/container.py b/docker/api/container.py
@@ -966,7 +966,7 @@ def put_archive(self, container, path, data):
             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
@@ -324,7 +324,7 @@ def put_archive(self, path, data):
         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.