summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJacob Vosmaer <jacob@gitlab.com>2014-08-06 15:54:48 +0000
committerJacob Vosmaer <jacob@gitlab.com>2014-08-06 15:54:48 +0000
commit15eaeb8ee1dff77788606dbac4bddd39a43b1b4a (patch)
tree1aaf0a1830363633504b8b76eb41307e224e861f /doc
parent352af72f434046b1c1562641f904b4d20fe7ef54 (diff)
parent43f560b17461d035bb5b9cb18a69f68512465453 (diff)
downloadgitlab-ce-15eaeb8ee1dff77788606dbac4bddd39a43b1b4a.tar.gz
Merge branch 'doc/api_file_edit' into 'master'
Make file edit error message less specific See merge request !1007
Diffstat (limited to 'doc')
-rw-r--r--doc/api/repository_files.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md
index ae56b04b6ce..b53d60bceec 100644
--- a/doc/api/repository_files.md
+++ b/doc/api/repository_files.md
@@ -80,6 +80,15 @@ Parameters:
- `content` (required) - New file content
- `commit_message` (required) - Commit message
+If the commit fails for any reason we return a 400 error with a non-specific
+error message. Possible causes for a failed commit include:
+- the `file_path` contained `/../` (attempted directory traversal);
+- the new file contents were identical to the current file contents, i.e. the
+ user tried to make an empty commit;
+- the branch was updated by a Git push while the file edit was in progress.
+
+Currently gitlab-shell has a boolean return code, preventing GitLab from specifying the error.
+
## Delete existing file in repository
```