summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSean McGivern <sean@mcgivern.me.uk>2016-12-20 14:36:50 +0000
committerSean McGivern <sean@mcgivern.me.uk>2016-12-20 14:36:50 +0000
commitd84cfeaf21bb60c09061ad6c7bf135c37d063162 (patch)
treef9a1fceb8d6b9f21c79464484fd599bdecb6d38c /doc
parent1139da2745eb28be17c8fd6aa0f5de113c0f06a9 (diff)
parentc87d93d462bb83caebd22bd759d8a1ead845d6a4 (diff)
downloadgitlab-ce-d84cfeaf21bb60c09061ad6c7bf135c37d063162.tar.gz
Merge branch '4269-public-repositories-api' into 'master'
Allow Repositories API GET endpoints to be requested anonymously Closes #4269 See merge request !8148
Diffstat (limited to 'doc')
-rw-r--r--doc/api/repositories.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/api/repositories.md b/doc/api/repositories.md
index bcf8b955044..727617f1ecc 100644
--- a/doc/api/repositories.md
+++ b/doc/api/repositories.md
@@ -2,7 +2,8 @@
## List repository tree
-Get a list of repository files and directories in a project.
+Get a list of repository files and directories in a project. This endpoint can
+be accessed without authentication if the repository is publicly accessible.
```
GET /projects/:id/repository/tree
@@ -71,7 +72,8 @@ Parameters:
## Raw file content
-Get the raw file contents for a file by commit SHA and path.
+Get the raw file contents for a file by commit SHA and path. This endpoint can
+be accessed without authentication if the repository is publicly accessible.
```
GET /projects/:id/repository/blobs/:sha
@@ -85,7 +87,8 @@ Parameters:
## Raw blob content
-Get the raw file contents for a blob by blob SHA.
+Get the raw file contents for a blob by blob SHA. This endpoint can be accessed
+without authentication if the repository is publicly accessible.
```
GET /projects/:id/repository/raw_blobs/:sha
@@ -98,7 +101,8 @@ Parameters:
## Get file archive
-Get an archive of the repository
+Get an archive of the repository. This endpoint can be accessed without
+authentication if the repository is publicly accessible.
```
GET /projects/:id/repository/archive
@@ -111,6 +115,9 @@ Parameters:
## Compare branches, tags or commits
+This endpoint can be accessed without authentication if the repository is
+publicly accessible.
+
```
GET /projects/:id/repository/compare
```
@@ -163,7 +170,8 @@ Response:
## Contributors
-Get repository contributors list
+Get repository contributors list. This endpoint can be accessed without
+authentication if the repository is publicly accessible.
```
GET /projects/:id/repository/contributors