BigW Consortium Gitlab

repository_files.md 4.63 KB
Newer Older
1
# Repository files API
2

Ciro Santilli committed
3
**CRUD for repository files**
4

Ciro Santilli committed
5
**Create, read, update and delete repository files using this API**
6 7 8

## Get file from repository

9 10 11
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.
12 13

```
14
GET /projects/:id/repository/files/:file_path
15 16
```

17
```bash
18
curl --request GET --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master'
19 20
```

21 22 23 24 25 26 27 28 29 30 31
Example response:

```json
{
  "file_name": "key.rb",
  "file_path": "app/models/key.rb",
  "size": 1476,
  "encoding": "base64",
  "content": "IyA9PSBTY2hlbWEgSW5mb3...",
  "ref": "master",
  "blob_id": "79f7bbd25901e8334750839545a9bd021f0e4c83",
32 33
  "commit_id": "d5a3ff139356ce33e37e73add446f16869741b50",
  "last_commit_id": "570e7b2abdd848b95f2f578043fc23bd6f6fd24d"
34 35 36 37 38
}
```

Parameters:

39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
- `file_path` (required) - Url encoded full path to new file. Ex. lib%2Fclass%2Erb
- `ref` (required) - The name of branch, tag or commit

## Get raw file from repository

```
GET /projects/:id/repository/files/:file_path/raw
```

```bash
curl --request GET --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb/raw?ref=master'
```

Parameters:

- `file_path` (required) - Url encoded full path to new file. Ex. lib%2Fclass%2Erb
55
- `ref` (required) - The name of branch, tag or commit
56 57 58 59

## Create new file in repository

```
60
POST /projects/:id/repository/files/:file_path
61 62
```

63
```bash
64
curl --request POST --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v4/projects/13083/repository/app%2Fprojectrb%2E?branch=master&author_email=author%40example.com&author_name=Firstname%20Lastname&content=some%20content&commit_message=create%20a%20new%20file'
65 66
```

67 68 69 70
Example response:

```json
{
71 72
  "file_name": "app/project.rb",
  "branch": "master"
73 74 75 76 77
}
```

Parameters:

78
- `file_path` (required) - Url encoded full path to new file. Ex. lib%2Fclass%2Erb
79
- `branch` (required) - The name of branch
80
- `encoding` (optional) - Change encoding to 'base64'. Default is text.
81 82
- `author_email` (optional) - Specify the commit author's email address
- `author_name` (optional) - Specify the commit author's name
83 84
- `content` (required) - File content
- `commit_message` (required) - Commit message
85 86 87 88

## Update existing file in repository

```
89
PUT /projects/:id/repository/files/:file_path
90 91
```

92
```bash
93
curl --request PUT --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v4/projects/13083/repository/app%2Fproject%2Erb?branch=master&author_email=author%40example.com&author_name=Firstname%20Lastname&content=some%20other%20content&commit_message=update%20file'
94 95
```

96 97 98 99
Example response:

```json
{
100 101
  "file_name": "app/project.rb",
  "branch": "master"
102 103 104 105 106
}
```

Parameters:

107
- `file_path` (required) - Url encoded full path to new file. Ex. lib%2Fclass%2Erb
108
- `branch` (required) - The name of branch
109
- `encoding` (optional) - Change encoding to 'base64'. Default is text.
110 111
- `author_email` (optional) - Specify the commit author's email address
- `author_name` (optional) - Specify the commit author's name
112 113
- `content` (required) - New file content
- `commit_message` (required) - Commit message
114
- `last_commit_id` (optional) - Last known file commit id
115

116 117 118 119 120 121 122
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.

Sytse Sijbrandij committed
123 124
Currently gitlab-shell has a boolean return code, preventing GitLab from specifying the error.

125 126 127
## Delete existing file in repository

```
128
DELETE /projects/:id/repository/files/:file_path
129 130
```

131
```bash
132
curl --request DELETE --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v4/projects/13083/repository/app%2Fproject%2Erb?branch=master&author_email=author%40example.com&author_name=Firstname%20Lastname&commit_message=delete%20file'
133 134
```

135 136 137 138
Example response:

```json
{
139 140
  "file_name": "app/project.rb",
  "branch": "master"
141 142 143 144 145
}
```

Parameters:

146
- `file_path` (required) - Url encoded full path to new file. Ex. lib%2Fclass%2Erb
147
- `branch` (required) - The name of branch
148 149
- `author_email` (optional) - Specify the commit author's email address
- `author_name` (optional) - Specify the commit author's name
150
- `commit_message` (required) - Commit message