diff options
| author | Stan Hu <stanhu@gmail.com> | 2018-12-02 21:14:42 -0800 |
|---|---|---|
| committer | Stan Hu <stanhu@gmail.com> | 2018-12-03 08:58:45 -0800 |
| commit | c27c9827bc77565f9de40d403b05ce5b5ec22106 (patch) | |
| tree | bd97168eb6c16bb00ee9355f8fb7244742b72a68 | |
| parent | a445aa0a9267f191fab1c46d438b42fbec549da5 (diff) | |
| download | gitlab-ce-c27c9827bc77565f9de40d403b05ce5b5ec22106.tar.gz | |
Fix documentation for /api/v4/projects/:id/repository/archive
The documentation mistakenly says that `format` can be used as a
parameter, but the Grape middleware reserves `format` as a content-type
header. Update the documentation to make it explicit the suffix
should be used to specify a format.
Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/45992
| -rw-r--r-- | doc/api/repositories.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/api/repositories.md b/doc/api/repositories.md index c8de7f2191d..55f5a4cc3b2 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -108,14 +108,18 @@ Get an archive of the repository. This endpoint can be accessed without authentication if the repository is publicly accessible. ``` -GET /projects/:id/repository/archive +GET /projects/:id/repository/archive[.format] ``` +`format` is an optional suffix for the archive format. Default is +`tar.gz`. Options are `tar.gz`, `tar.bz2`, `tbz`, 'tbz2`, `tb2`, +`bz2`, `tar`, and `zip`. For example, specifying `archive.zip` +would send an archive in ZIP format. + Parameters: - `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user - `sha` (optional) - The commit SHA to download. A tag, branch reference or sha can be used. This defaults to the tip of the default branch if not specified -- `format` (optional) - The archive format. Default is `tar.gz`. Options are `tar.gz`, `tar.bz2`, `tbz`, `tbz2`, `tb2`, `bz2`, `tar`, `zip` ## Compare branches, tags or commits |