BigW Consortium Gitlab

repository_files.md 2.46 KB
Newer Older
1 2
# Repository files

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
Allows you to receive information about file in repository like name, size, content. Note that file content is Base64 encoded.
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

```
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:

32 33
- `file_path` (required) - Full path to new file. Ex. lib/class.rb
- `ref` (required) - The name of branch, tag or commit
34 35 36 37 38 39 40 41 42 43 44 45

## Create new file in repository

```
POST /projects/:id/repository/files
```

Example response:

```json
{
  "file_name": "app/project.rb",
46
  "branch_name": "master"
47 48 49 50 51
}
```

Parameters:

52 53 54 55 56
- `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
57 58 59 60 61 62 63 64 65 66 67 68

## Update existing file in repository

```
PUT /projects/:id/repository/files
```

Example response:

```json
{
  "file_name": "app/project.rb",
69
  "branch_name": "master"
70 71 72 73 74
}
```

Parameters:

75 76 77 78 79
- `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
80

81 82 83 84 85 86 87
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
88 89
Currently gitlab-shell has a boolean return code, preventing GitLab from specifying the error.

90 91 92 93 94 95 96 97 98 99 100
## Delete existing file in repository

```
DELETE /projects/:id/repository/files
```

Example response:

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

Parameters:

107 108 109
- `file_path` (required) - Full path to file. Ex. lib/class.rb
- `branch_name` (required) - The name of branch
- `commit_message` (required) - Commit message