From 5c915f4236f74aca766bf0126e1650f745ca9758 Mon Sep 17 00:00:00 2001 From: Marius Kleiner Date: Wed, 1 Mar 2017 18:43:23 +0000 Subject: [PATCH] Clarification of list repository tree API call --- changelogs/unreleased/26136-list-repository-tree-api-doc.yml | 4 ++++ doc/api/repositories.md | 2 ++ 2 files changed, 6 insertions(+) create mode 100644 changelogs/unreleased/26136-list-repository-tree-api-doc.yml 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 ```