debian-mirror-gitlab/doc/api/repository_files.md

275 lines
9.1 KiB
Markdown
Raw Normal View History

2017-09-10 17:25:29 +05:30
# Repository files API
2014-09-02 18:07:02 +05:30
**CRUD for repository files**
2020-04-08 14:13:33 +05:30
**Create, read, update, and delete repository files using this API**
2014-09-02 18:07:02 +05:30
2019-02-15 15:39:39 +05:30
The different scopes available using [personal access tokens](../user/profile/personal_access_tokens.md) are depicted
in the following table.
| Scope | Description |
| ----- | ----------- |
| `read_repository` | Allows read-access to the repository files. |
| `api` | Allows read-write access to the repository files. |
2020-03-13 15:44:24 +05:30
> `read_repository` scope was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23534) in GitLab 11.6.
2019-02-15 15:39:39 +05:30
2014-09-02 18:07:02 +05:30
## Get file from repository
2017-08-17 22:00:37 +05:30
Allows you to receive information about file in repository like name, size,
content. Note that file content is Base64 encoded. This endpoint can be accessed
without authentication if the repository is publicly accessible.
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /projects/:id/repository/files/:file_path
2014-09-02 18:07:02 +05:30
```
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master"
2016-09-13 17:45:13 +05:30
```
2014-09-02 18:07:02 +05:30
Example response:
```json
{
"file_name": "key.rb",
"file_path": "app/models/key.rb",
"size": 1476,
"encoding": "base64",
"content": "IyA9PSBTY2hlbWEgSW5mb3...",
2018-11-08 19:23:39 +05:30
"content_sha256": "4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481",
2014-09-02 18:07:02 +05:30
"ref": "master",
"blob_id": "79f7bbd25901e8334750839545a9bd021f0e4c83",
2015-11-26 14:37:03 +05:30
"commit_id": "d5a3ff139356ce33e37e73add446f16869741b50",
"last_commit_id": "570e7b2abdd848b95f2f578043fc23bd6f6fd24d"
2014-09-02 18:07:02 +05:30
}
```
Parameters:
2020-05-24 23:13:21 +05:30
- `file_path` (required) - URL encoded full path to new file. Ex. lib%2Fclass%2Erb
2017-08-17 22:00:37 +05:30
- `ref` (required) - The name of branch, tag or commit
2018-11-08 19:23:39 +05:30
NOTE: **Note:**
2020-06-23 00:09:42 +05:30
`blob_id` is the blob SHA, see [repositories - Get a blob from repository](repositories.md#get-a-blob-from-repository)
2018-11-08 19:23:39 +05:30
In addition to the `GET` method, you can also use `HEAD` to get just file metadata.
2020-04-08 14:13:33 +05:30
```plaintext
2018-11-08 19:23:39 +05:30
HEAD /projects/:id/repository/files/:file_path
```
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --head --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master"
2018-11-08 19:23:39 +05:30
```
Example response:
2020-05-24 23:13:21 +05:30
```plaintext
2018-11-08 19:23:39 +05:30
HTTP/1.1 200 OK
...
X-Gitlab-Blob-Id: 79f7bbd25901e8334750839545a9bd021f0e4c83
X-Gitlab-Commit-Id: d5a3ff139356ce33e37e73add446f16869741b50
X-Gitlab-Content-Sha256: 4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481
X-Gitlab-Encoding: base64
X-Gitlab-File-Name: key.rb
X-Gitlab-File-Path: app/models/key.rb
X-Gitlab-Last-Commit-Id: 570e7b2abdd848b95f2f578043fc23bd6f6fd24d
X-Gitlab-Ref: master
X-Gitlab-Size: 1476
...
```
2019-10-12 21:52:04 +05:30
## Get file blame from repository
2020-04-22 19:07:51 +05:30
Allows you to receive blame information. Each blame range contains lines and corresponding commit information.
2019-10-12 21:52:04 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2019-10-12 21:52:04 +05:30
GET /projects/:id/repository/files/:file_path/blame
```
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=master"
2019-10-12 21:52:04 +05:30
```
Example response:
```json
[
{
"commit": {
"id": "d42409d56517157c48bf3bd97d3f75974dde19fb",
"message": "Add feature\n\nalso fix bug\n",
"parent_ids": [
"cc6e14f9328fa6d7b5a0d3c30dc2002a3f2a3822"
],
"authored_date": "2015-12-18T08:12:22.000Z",
"author_name": "John Doe",
"author_email": "john.doe@example.com",
"committed_date": "2015-12-18T08:12:22.000Z",
"committer_name": "John Doe",
"committer_email": "john.doe@example.com"
},
"lines": [
"require 'fileutils'",
"require 'open3'",
""
]
},
...
]
```
Parameters:
2020-05-24 23:13:21 +05:30
- `file_path` (required) - URL encoded full path to new file. Ex. lib%2Fclass%2Erb
2019-10-12 21:52:04 +05:30
- `ref` (required) - The name of branch, tag or commit
NOTE: **Note:**
`HEAD` method return just file metadata as in [Get file from repository](repository_files.md#get-file-from-repository).
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --head --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=master"
2019-10-12 21:52:04 +05:30
```
Example response:
2020-05-24 23:13:21 +05:30
```plaintext
2019-10-12 21:52:04 +05:30
HTTP/1.1 200 OK
...
X-Gitlab-Blob-Id: 79f7bbd25901e8334750839545a9bd021f0e4c83
X-Gitlab-Commit-Id: d5a3ff139356ce33e37e73add446f16869741b50
X-Gitlab-Content-Sha256: 4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481
X-Gitlab-Encoding: base64
X-Gitlab-File-Name: file.rb
X-Gitlab-File-Path: path/to/file.rb
X-Gitlab-Last-Commit-Id: 570e7b2abdd848b95f2f578043fc23bd6f6fd24d
X-Gitlab-Ref: master
X-Gitlab-Size: 1476
...
```
2017-08-17 22:00:37 +05:30
## Get raw file from repository
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /projects/:id/repository/files/:file_path/raw
```
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb/raw?ref=master"
2017-08-17 22:00:37 +05:30
```
Parameters:
2020-05-24 23:13:21 +05:30
- `file_path` (required) - URL encoded full path to new file. Ex. lib%2Fclass%2Erb
2014-09-02 18:07:02 +05:30
- `ref` (required) - The name of branch, tag or commit
2018-11-08 19:23:39 +05:30
NOTE: **Note:**
Like [Get file from repository](repository_files.md#get-file-from-repository) you can use `HEAD` to get just file metadata.
2014-09-02 18:07:02 +05:30
## Create new file in repository
2020-04-08 14:13:33 +05:30
This allows you to create a single file. For creating multiple files with a single request see the [commits API](commits.md#create-a-commit-with-multiple-files-and-actions).
2018-12-05 23:21:45 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/repository/files/:file_path
2014-09-02 18:07:02 +05:30
```
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header 'PRIVATE-TOKEN: <your_access_token>' --header "Content-Type: application/json" \
2018-12-13 13:39:08 +05:30
--data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \
"content": "some content", "commit_message": "create a new file"}' \
2020-06-23 00:09:42 +05:30
"https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb"
2016-09-13 17:45:13 +05:30
```
2014-09-02 18:07:02 +05:30
Example response:
```json
{
2018-03-17 18:26:18 +05:30
"file_path": "app/project.rb",
2017-08-17 22:00:37 +05:30
"branch": "master"
2014-09-02 18:07:02 +05:30
}
```
Parameters:
2020-05-24 23:13:21 +05:30
- `file_path` (required) - URL encoded full path to new file. Ex. lib%2Fclass%2Erb
2017-09-10 17:25:29 +05:30
- `branch` (required) - Name of the branch
- `start_branch` (optional) - Name of the branch to start the new commit from
2017-08-17 22:00:37 +05:30
- `encoding` (optional) - Change encoding to 'base64'. Default is text.
2016-09-29 09:46:39 +05:30
- `author_email` (optional) - Specify the commit author's email address
- `author_name` (optional) - Specify the commit author's name
2014-09-02 18:07:02 +05:30
- `content` (required) - File content
- `commit_message` (required) - Commit message
## Update existing file in repository
2020-04-08 14:13:33 +05:30
This allows you to update a single file. For updating multiple files with a single request see the [commits API](commits.md#create-a-commit-with-multiple-files-and-actions).
2018-12-05 23:21:45 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
PUT /projects/:id/repository/files/:file_path
2014-09-02 18:07:02 +05:30
```
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request PUT --header 'PRIVATE-TOKEN: <your_access_token>' --header "Content-Type: application/json" \
2018-12-13 13:39:08 +05:30
--data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \
"content": "some content", "commit_message": "update file"}' \
2020-06-23 00:09:42 +05:30
"https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb"
2016-09-13 17:45:13 +05:30
```
2014-09-02 18:07:02 +05:30
Example response:
```json
{
2018-03-17 18:26:18 +05:30
"file_path": "app/project.rb",
2017-08-17 22:00:37 +05:30
"branch": "master"
2014-09-02 18:07:02 +05:30
}
```
Parameters:
2020-05-24 23:13:21 +05:30
- `file_path` (required) - URL encoded full path to new file. Ex. lib%2Fclass%2Erb
2017-09-10 17:25:29 +05:30
- `branch` (required) - Name of the branch
- `start_branch` (optional) - Name of the branch to start the new commit from
2017-08-17 22:00:37 +05:30
- `encoding` (optional) - Change encoding to 'base64'. Default is text.
2016-09-29 09:46:39 +05:30
- `author_email` (optional) - Specify the commit author's email address
- `author_name` (optional) - Specify the commit author's name
2014-09-02 18:07:02 +05:30
- `content` (required) - New file content
- `commit_message` (required) - Commit message
2020-05-24 23:13:21 +05:30
- `last_commit_id` (optional) - Last known file commit ID
2014-09-02 18:07:02 +05:30
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:
2019-07-07 11:18:12 +05:30
2014-09-02 18:07:02 +05:30
- the `file_path` contained `/../` (attempted directory traversal);
2020-04-08 14:13:33 +05:30
- the new file contents were identical to the current file contents. That is, the
2014-09-02 18:07:02 +05:30
user tried to make an empty commit;
- the branch was updated by a Git push while the file edit was in progress.
2019-12-04 20:38:33 +05:30
Currently GitLab Shell has a boolean return code, preventing GitLab from specifying the error.
2014-09-02 18:07:02 +05:30
## Delete existing file in repository
2020-04-08 14:13:33 +05:30
This allows you to delete a single file. For deleting multiple files with a single request, see the [commits API](commits.md#create-a-commit-with-multiple-files-and-actions).
2018-12-05 23:21:45 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
DELETE /projects/:id/repository/files/:file_path
2014-09-02 18:07:02 +05:30
```
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request DELETE --header 'PRIVATE-TOKEN: <your_access_token>' --header "Content-Type: application/json" \
2018-12-13 13:39:08 +05:30
--data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \
"commit_message": "delete file"}' \
2020-06-23 00:09:42 +05:30
"https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb"
2016-09-13 17:45:13 +05:30
```
2014-09-02 18:07:02 +05:30
Parameters:
2020-05-24 23:13:21 +05:30
- `file_path` (required) - URL encoded full path to new file. Ex. lib%2Fclass%2Erb
2017-09-10 17:25:29 +05:30
- `branch` (required) - Name of the branch
- `start_branch` (optional) - Name of the branch to start the new commit from
2016-09-29 09:46:39 +05:30
- `author_email` (optional) - Specify the commit author's email address
- `author_name` (optional) - Specify the commit author's name
2014-09-02 18:07:02 +05:30
- `commit_message` (required) - Commit message
2020-05-24 23:13:21 +05:30
- `last_commit_id` (optional) - Last known file commit ID