CRUD for repository files
Create, read, update and delete repository files using this API
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:
{
"file_name": "key.rb",
"file_path": "app/models/key.rb",
"size": 1476,
"encoding": "base64",
"content": "IyA9PSBTY2hlbWEgSW5mb3...",
"ref": "master",
"blob_id": "79f7bbd25901e8334750839545a9bd021f0e4c83",
"commit_id": "d5a3ff139356ce33e37e73add446f16869741b50",
"last_commit_id": "570e7b2abdd848b95f2f578043fc23bd6f6fd24d"
}
Parameters:
file_path
(required) - Full path to new file. Ex. lib/class.rbref
(required) - The name of branch, tag or commit
POST /projects/:id/repository/files
Example response:
{
"file_name": "app/project.rb",
"branch_name": "master"
}
Parameters:
file_path
(required) - Full path to new file. Ex. lib/class.rbbranch_name
(required) - The name of branchencoding
(optional) - 'text' or 'base64'. Text is default.content
(required) - File contentcommit_message
(required) - Commit message
PUT /projects/:id/repository/files
Example response:
{
"file_name": "app/project.rb",
"branch_name": "master"
}
Parameters:
file_path
(required) - Full path to file. Ex. lib/class.rbbranch_name
(required) - The name of branchencoding
(optional) - 'text' or 'base64'. Text is default.content
(required) - New file contentcommit_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 /projects/:id/repository/files
Example response:
{
"file_name": "app/project.rb",
"branch_name": "master"
}
Parameters:
file_path
(required) - Full path to file. Ex. lib/class.rbbranch_name
(required) - The name of branchcommit_message
(required) - Commit message