BigW Consortium Gitlab

repositories.md 3.76 KB
Newer Older
1 2
# Repositories

3 4 5 6 7 8 9 10 11 12
## List repository tree

Get a list of repository files and directories in a project.

```
GET /projects/:id/repository/tree
```

Parameters:

Ciro Santilli committed
13 14 15
- `id` (required) - The ID of a project
- `path` (optional) - The path inside repository. Used to get contend of subdirectories
- `ref_name` (optional) - The name of a repository branch or tag or if not given the default branch
16 17

```json
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
[
  {
    "name": "assets",
    "type": "tree",
    "mode": "040000",
    "id": "6229c43a7e16fcc7e95f923f8ddadb8281d9c6c6"
  },
  {
    "name": "contexts",
    "type": "tree",
    "mode": "040000",
    "id": "faf1cdf33feadc7973118ca42d35f1e62977e91f"
  },
  {
    "name": "controllers",
    "type": "tree",
    "mode": "040000",
    "id": "95633e8d258bf3dfba3a5268fb8440d263218d74"
  },
  {
    "name": "Rakefile",
    "type": "blob",
    "mode": "100644",
    "id": "35b2f05cbb4566b71b34554cf184a9d0bd9d46d6"
  },
  {
    "name": "VERSION",
    "type": "blob",
    "mode": "100644",
    "id": "803e4a4f3727286c3093c63870c2b6524d30ec4f"
  },
  {
    "name": "config.ru",
    "type": "blob",
    "mode": "100644",
    "id": "dfd2d862237323aa599be31b473d70a8a817943b"
  }
]
56 57
```

58
## Raw file content
59

60
Get the raw file contents for a file by commit SHA and path.
61 62

```
63
GET /projects/:id/repository/blobs/:sha
64 65 66 67
```

Parameters:

Ciro Santilli committed
68 69 70
- `id` (required) - The ID of a project
- `sha` (required) - The commit or branch name
- `filepath` (required) - The path the file
71

72 73
## Raw blob content

74
Get the raw file contents for a blob by blob SHA.
75 76 77 78 79 80 81

```
GET /projects/:id/repository/raw_blobs/:sha
```

Parameters:

Ciro Santilli committed
82 83
- `id` (required) - The ID of a project
- `sha` (required) - The blob SHA
84

85 86
## Get file archive

Ciro Santilli committed
87
Get an archive of the repository
88 89 90 91 92 93

```
GET /projects/:id/repository/archive
```

Parameters:
94

Ciro Santilli committed
95 96
- `id` (required) - The ID of a project
- `sha` (optional) - The commit SHA to download defaults to the tip of the default branch
97 98 99 100 101 102 103 104 105

## Compare branches, tags or commits

```
GET /projects/:id/repository/compare
```

Parameters:

Ciro Santilli committed
106 107 108
- `id` (required) - The ID of a project
- `from` (required) - the commit SHA or branch name
- `to` (required) - the commit SHA or branch name
109 110 111 112 113

```
GET /projects/:id/repository/compare?from=master&to=feature
```

114
Response:
115 116

```json
117

118 119
{
  "commit": {
120 121 122
    "id": "12d65c8dd2b2676fa3ac47d955accc085a37a9c1",
    "short_id": "12d65c8dd2b",
    "title": "JS fix",
123 124
    "author_name": "Dmitriy Zaporozhets",
    "author_email": "dmitriy.zaporozhets@gmail.com",
125
    "created_at": "2014-02-27T10:27:00+02:00"
126 127
  },
  "commits": [{
128 129 130
    "id": "12d65c8dd2b2676fa3ac47d955accc085a37a9c1",
    "short_id": "12d65c8dd2b",
    "title": "JS fix",
131 132
    "author_name": "Dmitriy Zaporozhets",
    "author_email": "dmitriy.zaporozhets@gmail.com",
133
    "created_at": "2014-02-27T10:27:00+02:00"
134 135
  }],
  "diffs": [{
136 137
    "old_path": "files/js/application.js",
    "new_path": "files/js/application.js",
138
    "a_mode": null,
139 140 141
    "b_mode": "100644",
    "diff": "--- a/files/js/application.js\n+++ b/files/js/application.js\n@@ -24,8 +24,10 @@\n //= require g.raphael-min\n //= require g.bar-min\n //= require branch-graph\n-//= require highlightjs.min\n-//= require ace/ace\n //= require_tree .\n //= require d3\n //= require underscore\n+\n+function fix() { \n+  alert(\"Fixed\")\n+}",
    "new_file": false,
142 143
    "renamed_file": false,
    "deleted_file": false
144 145 146
  }],
  "compare_timeout": false,
  "compare_same_ref": false
147 148
}
```
149 150 151 152 153 154 155 156 157 158

## Contributors

Get repository contributors list

```
GET /projects/:id/repository/contributors
```

Parameters:
Ciro Santilli committed
159 160

- `id` (required) - The ID of a project
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

Response:

```
[{
  "name": "Dmitriy Zaporozhets",
  "email": "dmitriy.zaporozhets@gmail.com",
  "commits": 117,
  "additions": 2097,
  "deletions": 517
}, {
  "name": "Jacob Vosmaer",
  "email": "contact@jacobvosmaer.nl",
  "commits": 33,
  "additions": 338,
  "deletions": 244
}]
```