summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarius Kleiner <kleiner@gmail.com>2017-03-01 18:43:23 +0000
committerRémy Coutable <remy@rymai.me>2017-03-01 18:43:23 +0000
commit5c915f4236f74aca766bf0126e1650f745ca9758 (patch)
treece281466a5a3c79df23e3471a17b052cbc75af03
parentf33bd9aeb722bb8fc8dbf4d93766d33fdb51c306 (diff)
downloadgitlab-ce-5c915f4236f74aca766bf0126e1650f745ca9758.tar.gz
Clarification of list repository tree API call
-rw-r--r--changelogs/unreleased/26136-list-repository-tree-api-doc.yml4
-rw-r--r--doc/api/repositories.md2
2 files changed, 6 insertions, 0 deletions
diff --git a/changelogs/unreleased/26136-list-repository-tree-api-doc.yml b/changelogs/unreleased/26136-list-repository-tree-api-doc.yml
new file mode 100644
index 00000000000..85d8bc6ca8a
--- /dev/null
+++ b/changelogs/unreleased/26136-list-repository-tree-api-doc.yml
@@ -0,0 +1,4 @@
+---
+title: Make documentation of list repository tree API call more detailed
+merge_request: 9532
+author: Marius Kleiner
diff --git a/doc/api/repositories.md b/doc/api/repositories.md
index 727617f1ecc..ddd11bb2a14 100644
--- a/doc/api/repositories.md
+++ b/doc/api/repositories.md
@@ -5,6 +5,8 @@
Get a list of repository files and directories in a project. This endpoint can
be accessed without authentication if the repository is publicly accessible.
+This command provides essentially the same functionality as the `git ls-tree` command. For more information, see the section _Tree Objects_ in the [Git internals documentation](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects/#_tree_objects).
+
```
GET /projects/:id/repository/tree
```