Commit 15eaeb8e authored by Jacob Vosmaer's avatar Jacob Vosmaer

Merge branch 'doc/api_file_edit' into 'master'

Make file edit error message less specific

See merge request !1007
parents 352af72f 43f560b1
...@@ -33,7 +33,7 @@ module Files ...@@ -33,7 +33,7 @@ module Files
if created_successfully if created_successfully
success success
else else
error("Your changes could not be committed, because the file has been changed") error("Your changes could not be committed. Maybe the file was changed by another process or there was nothing to commit?")
end end
end end
end end
......
...@@ -80,6 +80,15 @@ Parameters: ...@@ -80,6 +80,15 @@ Parameters:
- `content` (required) - New file content - `content` (required) - New file content
- `commit_message` (required) - Commit message - `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 ## Delete existing file in repository
``` ```
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment