diff options
author | Job van der Voort <jobvandervoort@gmail.com> | 2015-04-21 16:21:51 +0200 |
---|---|---|
committer | Job van der Voort <jobvandervoort@gmail.com> | 2015-04-21 16:21:51 +0200 |
commit | a8e93b7f51d968c1380ed210499869b62b07fd15 (patch) | |
tree | c864e80dfd9cf4f83fcede678acc986e3a125bf5 /doc/api/repository_files.md | |
parent | 0625b15a481b3a3edd88110b3c18031ad9068d2f (diff) | |
download | gitlab-ce-a8e93b7f51d968c1380ed210499869b62b07fd15.tar.gz |
Version 7.10.0.rc5v7.10.0.rc5
Diffstat (limited to 'doc/api/repository_files.md')
-rw-r--r-- | doc/api/repository_files.md | 109 |
1 files changed, 0 insertions, 109 deletions
diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md deleted file mode 100644 index 25311b07107..00000000000 --- a/doc/api/repository_files.md +++ /dev/null @@ -1,109 +0,0 @@ -# Repository files - -**CRUD for repository files** - -**Create, read, update and delete repository files using this API** - -## Get file from repository - -Allows you to receive information about file in repository like name, size, content. Note that file content is Base64 encoded. - -``` -GET /projects/:id/repository/files -``` - -Example response: - -```json -{ - "file_name": "key.rb", - "file_path": "app/models/key.rb", - "size": 1476, - "encoding": "base64", - "content": "IyA9PSBTY2hlbWEgSW5mb3...", - "ref": "master", - "blob_id": "79f7bbd25901e8334750839545a9bd021f0e4c83", - "commit_id": "d5a3ff139356ce33e37e73add446f16869741b50" -} -``` - -Parameters: - -- `file_path` (required) - Full path to new file. Ex. lib/class.rb -- `ref` (required) - The name of branch, tag or commit - -## Create new file in repository - -``` -POST /projects/:id/repository/files -``` - -Example response: - -```json -{ - "file_name": "app/project.rb", - "branch_name": "master" -} -``` - -Parameters: - -- `file_path` (required) - Full path to new file. Ex. lib/class.rb -- `branch_name` (required) - The name of branch -- `encoding` (optional) - 'text' or 'base64'. Text is default. -- `content` (required) - File content -- `commit_message` (required) - Commit message - -## Update existing file in repository - -``` -PUT /projects/:id/repository/files -``` - -Example response: - -```json -{ - "file_name": "app/project.rb", - "branch_name": "master" -} -``` - -Parameters: - -- `file_path` (required) - Full path to file. Ex. lib/class.rb -- `branch_name` (required) - The name of branch -- `encoding` (optional) - 'text' or 'base64'. Text is default. -- `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 - -``` -DELETE /projects/:id/repository/files -``` - -Example response: - -```json -{ - "file_name": "app/project.rb", - "branch_name": "master" -} -``` - -Parameters: - -- `file_path` (required) - Full path to file. Ex. lib/class.rb -- `branch_name` (required) - The name of branch -- `commit_message` (required) - Commit message |