summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorMax Ludwig <mail@danjou.de>2021-07-31 22:26:26 +0200
committerJohn Villalovos <john@sodarock.com>2021-12-21 09:04:22 -0800
commit83dcabf3b04af63318c981317778f74857279909 (patch)
treecd1501961fafcf609835436fa8b93c20bdddaf22 /docs/gl_objects
parenteef8059d63f4c882fca6390ae18e3002e86c90d9 (diff)
downloadgitlab-83dcabf3b04af63318c981317778f74857279909.tar.gz
feat(api): support file format for repository archive
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/projects.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
index 3ff7241..4bae083 100644
--- a/docs/gl_objects/projects.rst
+++ b/docs/gl_objects/projects.rst
@@ -180,6 +180,14 @@ Get the repository archive::
# get the archive for a branch/tag/commit
tgz = project.repository_archive(sha='4567abc')
+ # get the archive in a different format
+ zip = project.repository_archive(format='zip')
+
+.. note::
+
+ For the formats available, refer to
+ https://docs.gitlab.com/ce/api/repositories.html#get-file-archive
+
.. warning::
Archives are entirely stored in memory unless you use the streaming feature.