@templmf/temp-solf-lmf 0.0.109 → 0.0.110
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package//347/247/273/345/212/250/345/272/224/347/224/250/351/235/236/347/256/241/347/220/206/345/221/230/351/205/215/347/275/256/350/247/222/350/211/262/346/270/205/345/215/225.xlsx +0 -0
- package/gitlab-foss-8-17-stable/doc/api/README.md +0 -391
- package/gitlab-foss-8-17-stable/doc/api/access_requests.md +0 -139
- package/gitlab-foss-8-17-stable/doc/api/award_emoji.md +0 -374
- package/gitlab-foss-8-17-stable/doc/api/boards.md +0 -241
- package/gitlab-foss-8-17-stable/doc/api/branches.md +0 -260
- package/gitlab-foss-8-17-stable/doc/api/broadcast_messages.md +0 -154
- package/gitlab-foss-8-17-stable/doc/api/build_triggers.md +0 -118
- package/gitlab-foss-8-17-stable/doc/api/build_variables.md +0 -128
- package/gitlab-foss-8-17-stable/doc/api/builds.md +0 -610
- package/gitlab-foss-8-17-stable/doc/api/ci/README.md +0 -24
- package/gitlab-foss-8-17-stable/doc/api/ci/builds.md +0 -147
- package/gitlab-foss-8-17-stable/doc/api/ci/lint.md +0 -49
- package/gitlab-foss-8-17-stable/doc/api/ci/runners.md +0 -59
- package/gitlab-foss-8-17-stable/doc/api/commits.md +0 -479
- package/gitlab-foss-8-17-stable/doc/api/deploy_key_multiple_projects.md +0 -29
- package/gitlab-foss-8-17-stable/doc/api/deploy_keys.md +0 -216
- package/gitlab-foss-8-17-stable/doc/api/deployments.md +0 -218
- package/gitlab-foss-8-17-stable/doc/api/enviroments.md +0 -121
- package/gitlab-foss-8-17-stable/doc/api/groups.md +0 -484
- package/gitlab-foss-8-17-stable/doc/api/issues.md +0 -856
- package/gitlab-foss-8-17-stable/doc/api/keys.md +0 -46
- package/gitlab-foss-8-17-stable/doc/api/labels.md +0 -257
- package/gitlab-foss-8-17-stable/doc/api/members.md +0 -175
- package/gitlab-foss-8-17-stable/doc/api/merge_requests.md +0 -1158
- package/gitlab-foss-8-17-stable/doc/api/milestones.md +0 -105
- package/gitlab-foss-8-17-stable/doc/api/namespaces.md +0 -70
- package/gitlab-foss-8-17-stable/doc/api/notes.md +0 -407
- package/gitlab-foss-8-17-stable/doc/api/notification_settings.md +0 -177
- package/gitlab-foss-8-17-stable/doc/api/oauth2.md +0 -137
- package/gitlab-foss-8-17-stable/doc/api/pipelines.md +0 -259
- package/gitlab-foss-8-17-stable/doc/api/project_snippets.md +0 -118
- package/gitlab-foss-8-17-stable/doc/api/projects.md +0 -1402
- package/gitlab-foss-8-17-stable/doc/api/repositories.md +0 -200
- package/gitlab-foss-8-17-stable/doc/api/repository_files.md +0 -134
- package/gitlab-foss-8-17-stable/doc/api/runners.md +0 -322
- package/gitlab-foss-8-17-stable/doc/api/services.md +0 -812
- package/gitlab-foss-8-17-stable/doc/api/session.md +0 -56
- package/gitlab-foss-8-17-stable/doc/api/settings.md +0 -126
- package/gitlab-foss-8-17-stable/doc/api/sidekiq_metrics.md +0 -152
- package/gitlab-foss-8-17-stable/doc/api/snippets.md +0 -232
- package/gitlab-foss-8-17-stable/doc/api/system_hooks.md +0 -146
- package/gitlab-foss-8-17-stable/doc/api/tags.md +0 -191
- package/gitlab-foss-8-17-stable/doc/api/templates/gitignores.md +0 -579
- package/gitlab-foss-8-17-stable/doc/api/templates/gitlab_ci_ymls.md +0 -120
- package/gitlab-foss-8-17-stable/doc/api/templates/licenses.md +0 -147
- package/gitlab-foss-8-17-stable/doc/api/todos.md +0 -296
- package/gitlab-foss-8-17-stable/doc/api/users.md +0 -835
- package/gitlab-foss-8-17-stable/doc/api/v3_to_v4.md +0 -14
- package/gitlab-foss-8-17-stable/doc/api/version.md +0 -23
|
@@ -1,200 +0,0 @@
|
|
|
1
|
-
# Repositories
|
|
2
|
-
|
|
3
|
-
## List repository tree
|
|
4
|
-
|
|
5
|
-
Get a list of repository files and directories in a project. This endpoint can
|
|
6
|
-
be accessed without authentication if the repository is publicly accessible.
|
|
7
|
-
|
|
8
|
-
```
|
|
9
|
-
GET /projects/:id/repository/tree
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Parameters:
|
|
13
|
-
|
|
14
|
-
- `id` (required) - The ID of a project
|
|
15
|
-
- `path` (optional) - The path inside repository. Used to get contend of subdirectories
|
|
16
|
-
- `ref_name` (optional) - The name of a repository branch or tag or if not given the default branch
|
|
17
|
-
- `recursive` (optional) - Boolean value used to get a recursive tree (false by default)
|
|
18
|
-
|
|
19
|
-
```json
|
|
20
|
-
[
|
|
21
|
-
{
|
|
22
|
-
"id": "a1e8f8d745cc87e3a9248358d9352bb7f9a0aeba",
|
|
23
|
-
"name": "html",
|
|
24
|
-
"type": "tree",
|
|
25
|
-
"path": "files/html",
|
|
26
|
-
"mode": "040000"
|
|
27
|
-
},
|
|
28
|
-
{
|
|
29
|
-
"id": "4535904260b1082e14f867f7a24fd8c21495bde3",
|
|
30
|
-
"name": "images",
|
|
31
|
-
"type": "tree",
|
|
32
|
-
"path": "files/images",
|
|
33
|
-
"mode": "040000"
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
"id": "31405c5ddef582c5a9b7a85230413ff90e2fe720",
|
|
37
|
-
"name": "js",
|
|
38
|
-
"type": "tree",
|
|
39
|
-
"path": "files/js",
|
|
40
|
-
"mode": "040000"
|
|
41
|
-
},
|
|
42
|
-
{
|
|
43
|
-
"id": "cc71111cfad871212dc99572599a568bfe1e7e00",
|
|
44
|
-
"name": "lfs",
|
|
45
|
-
"type": "tree",
|
|
46
|
-
"path": "files/lfs",
|
|
47
|
-
"mode": "040000"
|
|
48
|
-
},
|
|
49
|
-
{
|
|
50
|
-
"id": "fd581c619bf59cfdfa9c8282377bb09c2f897520",
|
|
51
|
-
"name": "markdown",
|
|
52
|
-
"type": "tree",
|
|
53
|
-
"path": "files/markdown",
|
|
54
|
-
"mode": "040000"
|
|
55
|
-
},
|
|
56
|
-
{
|
|
57
|
-
"id": "23ea4d11a4bdd960ee5320c5cb65b5b3fdbc60db",
|
|
58
|
-
"name": "ruby",
|
|
59
|
-
"type": "tree",
|
|
60
|
-
"path": "files/ruby",
|
|
61
|
-
"mode": "040000"
|
|
62
|
-
},
|
|
63
|
-
{
|
|
64
|
-
"id": "7d70e02340bac451f281cecf0a980907974bd8be",
|
|
65
|
-
"name": "whitespace",
|
|
66
|
-
"type": "blob",
|
|
67
|
-
"path": "files/whitespace",
|
|
68
|
-
"mode": "100644"
|
|
69
|
-
}
|
|
70
|
-
]
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
## Raw file content
|
|
74
|
-
|
|
75
|
-
Get the raw file contents for a file by commit SHA and path. This endpoint can
|
|
76
|
-
be accessed without authentication if the repository is publicly accessible.
|
|
77
|
-
|
|
78
|
-
```
|
|
79
|
-
GET /projects/:id/repository/blobs/:sha
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
Parameters:
|
|
83
|
-
|
|
84
|
-
- `id` (required) - The ID of a project
|
|
85
|
-
- `sha` (required) - The commit or branch name
|
|
86
|
-
- `filepath` (required) - The path the file
|
|
87
|
-
|
|
88
|
-
## Raw blob content
|
|
89
|
-
|
|
90
|
-
Get the raw file contents for a blob by blob SHA. This endpoint can be accessed
|
|
91
|
-
without authentication if the repository is publicly accessible.
|
|
92
|
-
|
|
93
|
-
```
|
|
94
|
-
GET /projects/:id/repository/raw_blobs/:sha
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
Parameters:
|
|
98
|
-
|
|
99
|
-
- `id` (required) - The ID of a project
|
|
100
|
-
- `sha` (required) - The blob SHA
|
|
101
|
-
|
|
102
|
-
## Get file archive
|
|
103
|
-
|
|
104
|
-
Get an archive of the repository. This endpoint can be accessed without
|
|
105
|
-
authentication if the repository is publicly accessible.
|
|
106
|
-
|
|
107
|
-
```
|
|
108
|
-
GET /projects/:id/repository/archive
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
Parameters:
|
|
112
|
-
|
|
113
|
-
- `id` (required) - The ID of a project
|
|
114
|
-
- `sha` (optional) - The commit SHA to download defaults to the tip of the default branch
|
|
115
|
-
|
|
116
|
-
## Compare branches, tags or commits
|
|
117
|
-
|
|
118
|
-
This endpoint can be accessed without authentication if the repository is
|
|
119
|
-
publicly accessible.
|
|
120
|
-
|
|
121
|
-
```
|
|
122
|
-
GET /projects/:id/repository/compare
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
Parameters:
|
|
126
|
-
|
|
127
|
-
- `id` (required) - The ID of a project
|
|
128
|
-
- `from` (required) - the commit SHA or branch name
|
|
129
|
-
- `to` (required) - the commit SHA or branch name
|
|
130
|
-
|
|
131
|
-
```
|
|
132
|
-
GET /projects/:id/repository/compare?from=master&to=feature
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
Response:
|
|
136
|
-
|
|
137
|
-
```json
|
|
138
|
-
|
|
139
|
-
{
|
|
140
|
-
"commit": {
|
|
141
|
-
"id": "12d65c8dd2b2676fa3ac47d955accc085a37a9c1",
|
|
142
|
-
"short_id": "12d65c8dd2b",
|
|
143
|
-
"title": "JS fix",
|
|
144
|
-
"author_name": "Dmitriy Zaporozhets",
|
|
145
|
-
"author_email": "dmitriy.zaporozhets@gmail.com",
|
|
146
|
-
"created_at": "2014-02-27T10:27:00+02:00"
|
|
147
|
-
},
|
|
148
|
-
"commits": [{
|
|
149
|
-
"id": "12d65c8dd2b2676fa3ac47d955accc085a37a9c1",
|
|
150
|
-
"short_id": "12d65c8dd2b",
|
|
151
|
-
"title": "JS fix",
|
|
152
|
-
"author_name": "Dmitriy Zaporozhets",
|
|
153
|
-
"author_email": "dmitriy.zaporozhets@gmail.com",
|
|
154
|
-
"created_at": "2014-02-27T10:27:00+02:00"
|
|
155
|
-
}],
|
|
156
|
-
"diffs": [{
|
|
157
|
-
"old_path": "files/js/application.js",
|
|
158
|
-
"new_path": "files/js/application.js",
|
|
159
|
-
"a_mode": null,
|
|
160
|
-
"b_mode": "100644",
|
|
161
|
-
"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+}",
|
|
162
|
-
"new_file": false,
|
|
163
|
-
"renamed_file": false,
|
|
164
|
-
"deleted_file": false
|
|
165
|
-
}],
|
|
166
|
-
"compare_timeout": false,
|
|
167
|
-
"compare_same_ref": false
|
|
168
|
-
}
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
## Contributors
|
|
172
|
-
|
|
173
|
-
Get repository contributors list. This endpoint can be accessed without
|
|
174
|
-
authentication if the repository is publicly accessible.
|
|
175
|
-
|
|
176
|
-
```
|
|
177
|
-
GET /projects/:id/repository/contributors
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
Parameters:
|
|
181
|
-
|
|
182
|
-
- `id` (required) - The ID of a project
|
|
183
|
-
|
|
184
|
-
Response:
|
|
185
|
-
|
|
186
|
-
```
|
|
187
|
-
[{
|
|
188
|
-
"name": "Dmitriy Zaporozhets",
|
|
189
|
-
"email": "dmitriy.zaporozhets@gmail.com",
|
|
190
|
-
"commits": 117,
|
|
191
|
-
"additions": 2097,
|
|
192
|
-
"deletions": 517
|
|
193
|
-
}, {
|
|
194
|
-
"name": "Jacob Vosmaer",
|
|
195
|
-
"email": "contact@jacobvosmaer.nl",
|
|
196
|
-
"commits": 33,
|
|
197
|
-
"additions": 338,
|
|
198
|
-
"deletions": 244
|
|
199
|
-
}]
|
|
200
|
-
```
|
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
# Repository files
|
|
2
|
-
|
|
3
|
-
**CRUD for repository files**
|
|
4
|
-
|
|
5
|
-
**Create, read, update and delete repository files using this API**
|
|
6
|
-
|
|
7
|
-
## Get file from repository
|
|
8
|
-
|
|
9
|
-
Allows you to receive information about file in repository like name, size,
|
|
10
|
-
content. Note that file content is Base64 encoded. This endpoint can be accessed
|
|
11
|
-
without authentication if the repository is publicly accessible.
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
GET /projects/:id/repository/files
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
curl --request GET --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/models/key.rb&ref=master'
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Example response:
|
|
22
|
-
|
|
23
|
-
```json
|
|
24
|
-
{
|
|
25
|
-
"file_name": "key.rb",
|
|
26
|
-
"file_path": "app/models/key.rb",
|
|
27
|
-
"size": 1476,
|
|
28
|
-
"encoding": "base64",
|
|
29
|
-
"content": "IyA9PSBTY2hlbWEgSW5mb3...",
|
|
30
|
-
"ref": "master",
|
|
31
|
-
"blob_id": "79f7bbd25901e8334750839545a9bd021f0e4c83",
|
|
32
|
-
"commit_id": "d5a3ff139356ce33e37e73add446f16869741b50",
|
|
33
|
-
"last_commit_id": "570e7b2abdd848b95f2f578043fc23bd6f6fd24d"
|
|
34
|
-
}
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
Parameters:
|
|
38
|
-
|
|
39
|
-
- `file_path` (required) - Full path to new file. Ex. lib/class.rb
|
|
40
|
-
- `ref` (required) - The name of branch, tag or commit
|
|
41
|
-
|
|
42
|
-
## Create new file in repository
|
|
43
|
-
|
|
44
|
-
```
|
|
45
|
-
POST /projects/:id/repository/files
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
|
-
curl --request POST --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/project.rb&branch_name=master&author_email=author%40example.com&author_name=Firstname%20Lastname&content=some%20content&commit_message=create%20a%20new%20file'
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Example response:
|
|
53
|
-
|
|
54
|
-
```json
|
|
55
|
-
{
|
|
56
|
-
"file_path": "app/project.rb",
|
|
57
|
-
"branch_name": "master"
|
|
58
|
-
}
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
Parameters:
|
|
62
|
-
|
|
63
|
-
- `file_path` (required) - Full path to new file. Ex. lib/class.rb
|
|
64
|
-
- `branch_name` (required) - The name of branch
|
|
65
|
-
- `encoding` (optional) - Change encoding to 'base64'. Default is text.
|
|
66
|
-
- `author_email` (optional) - Specify the commit author's email address
|
|
67
|
-
- `author_name` (optional) - Specify the commit author's name
|
|
68
|
-
- `content` (required) - File content
|
|
69
|
-
- `commit_message` (required) - Commit message
|
|
70
|
-
|
|
71
|
-
## Update existing file in repository
|
|
72
|
-
|
|
73
|
-
```
|
|
74
|
-
PUT /projects/:id/repository/files
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
```bash
|
|
78
|
-
curl --request PUT --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/project.rb&branch_name=master&author_email=author%40example.com&author_name=Firstname%20Lastname&content=some%20other%20content&commit_message=update%20file'
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
Example response:
|
|
82
|
-
|
|
83
|
-
```json
|
|
84
|
-
{
|
|
85
|
-
"file_path": "app/project.rb",
|
|
86
|
-
"branch_name": "master"
|
|
87
|
-
}
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
Parameters:
|
|
91
|
-
|
|
92
|
-
- `file_path` (required) - Full path to file. Ex. lib/class.rb
|
|
93
|
-
- `branch_name` (required) - The name of branch
|
|
94
|
-
- `encoding` (optional) - Change encoding to 'base64'. Default is text.
|
|
95
|
-
- `author_email` (optional) - Specify the commit author's email address
|
|
96
|
-
- `author_name` (optional) - Specify the commit author's name
|
|
97
|
-
- `content` (required) - New file content
|
|
98
|
-
- `commit_message` (required) - Commit message
|
|
99
|
-
|
|
100
|
-
If the commit fails for any reason we return a 400 error with a non-specific
|
|
101
|
-
error message. Possible causes for a failed commit include:
|
|
102
|
-
- the `file_path` contained `/../` (attempted directory traversal);
|
|
103
|
-
- the new file contents were identical to the current file contents, i.e. the
|
|
104
|
-
user tried to make an empty commit;
|
|
105
|
-
- the branch was updated by a Git push while the file edit was in progress.
|
|
106
|
-
|
|
107
|
-
Currently gitlab-shell has a boolean return code, preventing GitLab from specifying the error.
|
|
108
|
-
|
|
109
|
-
## Delete existing file in repository
|
|
110
|
-
|
|
111
|
-
```
|
|
112
|
-
DELETE /projects/:id/repository/files
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
```bash
|
|
116
|
-
curl --request PUT --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/project.rb&branch_name=master&author_email=author%40example.com&author_name=Firstname%20Lastname&commit_message=delete%20file'
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
Example response:
|
|
120
|
-
|
|
121
|
-
```json
|
|
122
|
-
{
|
|
123
|
-
"file_path": "app/project.rb",
|
|
124
|
-
"branch_name": "master"
|
|
125
|
-
}
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
Parameters:
|
|
129
|
-
|
|
130
|
-
- `file_path` (required) - Full path to file. Ex. lib/class.rb
|
|
131
|
-
- `branch_name` (required) - The name of branch
|
|
132
|
-
- `author_email` (optional) - Specify the commit author's email address
|
|
133
|
-
- `author_name` (optional) - Specify the commit author's name
|
|
134
|
-
- `commit_message` (required) - Commit message
|
|
@@ -1,322 +0,0 @@
|
|
|
1
|
-
# Runners API
|
|
2
|
-
|
|
3
|
-
> [Introduced][ce-2640] in GitLab 8.5
|
|
4
|
-
|
|
5
|
-
[ce-2640]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2640
|
|
6
|
-
|
|
7
|
-
## List owned runners
|
|
8
|
-
|
|
9
|
-
Get a list of specific runners available to the user.
|
|
10
|
-
|
|
11
|
-
```
|
|
12
|
-
GET /runners
|
|
13
|
-
GET /runners?scope=active
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
| Attribute | Type | Required | Description |
|
|
17
|
-
|-----------|---------|----------|---------------------|
|
|
18
|
-
| `scope` | string | no | The scope of specific runners to show, one of: `active`, `paused`, `online`; showing all runners if none provided |
|
|
19
|
-
|
|
20
|
-
```
|
|
21
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners"
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
Example response:
|
|
25
|
-
|
|
26
|
-
```json
|
|
27
|
-
[
|
|
28
|
-
{
|
|
29
|
-
"active": true,
|
|
30
|
-
"description": "test-1-20150125",
|
|
31
|
-
"id": 6,
|
|
32
|
-
"is_shared": false,
|
|
33
|
-
"name": null
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
"active": true,
|
|
37
|
-
"description": "test-2-20150125",
|
|
38
|
-
"id": 8,
|
|
39
|
-
"is_shared": false,
|
|
40
|
-
"name": null
|
|
41
|
-
}
|
|
42
|
-
]
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
## List all runners
|
|
46
|
-
|
|
47
|
-
Get a list of all runners in the GitLab instance (specific and shared). Access
|
|
48
|
-
is restricted to users with `admin` privileges.
|
|
49
|
-
|
|
50
|
-
```
|
|
51
|
-
GET /runners/all
|
|
52
|
-
GET /runners/all?scope=online
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
| Attribute | Type | Required | Description |
|
|
56
|
-
|-----------|---------|----------|---------------------|
|
|
57
|
-
| `scope` | string | no | The scope of runners to show, one of: `specific`, `shared`, `active`, `paused`, `online`; showing all runners if none provided |
|
|
58
|
-
|
|
59
|
-
```
|
|
60
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/all"
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
Example response:
|
|
64
|
-
|
|
65
|
-
```json
|
|
66
|
-
[
|
|
67
|
-
{
|
|
68
|
-
"active": true,
|
|
69
|
-
"description": "shared-runner-1",
|
|
70
|
-
"id": 1,
|
|
71
|
-
"is_shared": true,
|
|
72
|
-
"name": null
|
|
73
|
-
},
|
|
74
|
-
{
|
|
75
|
-
"active": true,
|
|
76
|
-
"description": "shared-runner-2",
|
|
77
|
-
"id": 3,
|
|
78
|
-
"is_shared": true,
|
|
79
|
-
"name": null
|
|
80
|
-
},
|
|
81
|
-
{
|
|
82
|
-
"active": true,
|
|
83
|
-
"description": "test-1-20150125",
|
|
84
|
-
"id": 6,
|
|
85
|
-
"is_shared": false,
|
|
86
|
-
"name": null
|
|
87
|
-
},
|
|
88
|
-
{
|
|
89
|
-
"active": true,
|
|
90
|
-
"description": "test-2-20150125",
|
|
91
|
-
"id": 8,
|
|
92
|
-
"is_shared": false,
|
|
93
|
-
"name": null
|
|
94
|
-
}
|
|
95
|
-
]
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
## Get runner's details
|
|
99
|
-
|
|
100
|
-
Get details of a runner.
|
|
101
|
-
|
|
102
|
-
```
|
|
103
|
-
GET /runners/:id
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
| Attribute | Type | Required | Description |
|
|
107
|
-
|-----------|---------|----------|---------------------|
|
|
108
|
-
| `id` | integer | yes | The ID of a runner |
|
|
109
|
-
|
|
110
|
-
```
|
|
111
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/6"
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
Example response:
|
|
115
|
-
|
|
116
|
-
```json
|
|
117
|
-
{
|
|
118
|
-
"active": true,
|
|
119
|
-
"architecture": null,
|
|
120
|
-
"description": "test-1-20150125",
|
|
121
|
-
"id": 6,
|
|
122
|
-
"is_shared": false,
|
|
123
|
-
"contacted_at": "2016-01-25T16:39:48.066Z",
|
|
124
|
-
"name": null,
|
|
125
|
-
"platform": null,
|
|
126
|
-
"projects": [
|
|
127
|
-
{
|
|
128
|
-
"id": 1,
|
|
129
|
-
"name": "GitLab Community Edition",
|
|
130
|
-
"name_with_namespace": "GitLab.org / GitLab Community Edition",
|
|
131
|
-
"path": "gitlab-ce",
|
|
132
|
-
"path_with_namespace": "gitlab-org/gitlab-ce"
|
|
133
|
-
}
|
|
134
|
-
],
|
|
135
|
-
"token": "205086a8e3b9a2b818ffac9b89d102",
|
|
136
|
-
"revision": null,
|
|
137
|
-
"tag_list": [
|
|
138
|
-
"ruby",
|
|
139
|
-
"mysql"
|
|
140
|
-
],
|
|
141
|
-
"version": null
|
|
142
|
-
}
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
## Update runner's details
|
|
146
|
-
|
|
147
|
-
Update details of a runner.
|
|
148
|
-
|
|
149
|
-
```
|
|
150
|
-
PUT /runners/:id
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
| Attribute | Type | Required | Description |
|
|
154
|
-
|---------------|---------|----------|---------------------|
|
|
155
|
-
| `id` | integer | yes | The ID of a runner |
|
|
156
|
-
| `description` | string | no | The description of a runner |
|
|
157
|
-
| `active` | boolean | no | The state of a runner; can be set to `true` or `false` |
|
|
158
|
-
| `tag_list` | array | no | The list of tags for a runner; put array of tags, that should be finally assigned to a runner |
|
|
159
|
-
|
|
160
|
-
```
|
|
161
|
-
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/6" --form "description=test-1-20150125-test" --form "tag_list=ruby,mysql,tag1,tag2"
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
Example response:
|
|
165
|
-
|
|
166
|
-
```json
|
|
167
|
-
{
|
|
168
|
-
"active": true,
|
|
169
|
-
"architecture": null,
|
|
170
|
-
"description": "test-1-20150125-test",
|
|
171
|
-
"id": 6,
|
|
172
|
-
"is_shared": false,
|
|
173
|
-
"contacted_at": "2016-01-25T16:39:48.066Z",
|
|
174
|
-
"name": null,
|
|
175
|
-
"platform": null,
|
|
176
|
-
"projects": [
|
|
177
|
-
{
|
|
178
|
-
"id": 1,
|
|
179
|
-
"name": "GitLab Community Edition",
|
|
180
|
-
"name_with_namespace": "GitLab.org / GitLab Community Edition",
|
|
181
|
-
"path": "gitlab-ce",
|
|
182
|
-
"path_with_namespace": "gitlab-org/gitlab-ce"
|
|
183
|
-
}
|
|
184
|
-
],
|
|
185
|
-
"token": "205086a8e3b9a2b818ffac9b89d102",
|
|
186
|
-
"revision": null,
|
|
187
|
-
"tag_list": [
|
|
188
|
-
"ruby",
|
|
189
|
-
"mysql",
|
|
190
|
-
"tag1",
|
|
191
|
-
"tag2"
|
|
192
|
-
],
|
|
193
|
-
"version": null
|
|
194
|
-
}
|
|
195
|
-
```
|
|
196
|
-
|
|
197
|
-
## Remove a runner
|
|
198
|
-
|
|
199
|
-
Remove a runner.
|
|
200
|
-
|
|
201
|
-
```
|
|
202
|
-
DELETE /runners/:id
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
| Attribute | Type | Required | Description |
|
|
206
|
-
|-----------|---------|----------|---------------------|
|
|
207
|
-
| `id` | integer | yes | The ID of a runner |
|
|
208
|
-
|
|
209
|
-
```
|
|
210
|
-
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/6"
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
Example response:
|
|
214
|
-
|
|
215
|
-
```json
|
|
216
|
-
{
|
|
217
|
-
"active": true,
|
|
218
|
-
"description": "test-1-20150125-test",
|
|
219
|
-
"id": 6,
|
|
220
|
-
"is_shared": false,
|
|
221
|
-
"name": null,
|
|
222
|
-
}
|
|
223
|
-
```
|
|
224
|
-
|
|
225
|
-
## List project's runners
|
|
226
|
-
|
|
227
|
-
List all runners (specific and shared) available in the project. Shared runners
|
|
228
|
-
are listed if at least one shared runner is defined **and** shared runners
|
|
229
|
-
usage is enabled in the project's settings.
|
|
230
|
-
|
|
231
|
-
```
|
|
232
|
-
GET /projects/:id/runners
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
| Attribute | Type | Required | Description |
|
|
236
|
-
|-----------|---------|----------|---------------------|
|
|
237
|
-
| `id` | integer | yes | The ID of a project |
|
|
238
|
-
|
|
239
|
-
```
|
|
240
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/9/runners"
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
Example response:
|
|
244
|
-
|
|
245
|
-
```json
|
|
246
|
-
[
|
|
247
|
-
{
|
|
248
|
-
"active": true,
|
|
249
|
-
"description": "test-2-20150125",
|
|
250
|
-
"id": 8,
|
|
251
|
-
"is_shared": false,
|
|
252
|
-
"name": null
|
|
253
|
-
},
|
|
254
|
-
{
|
|
255
|
-
"active": true,
|
|
256
|
-
"description": "development_runner",
|
|
257
|
-
"id": 5,
|
|
258
|
-
"is_shared": true,
|
|
259
|
-
"name": null
|
|
260
|
-
}
|
|
261
|
-
]
|
|
262
|
-
```
|
|
263
|
-
|
|
264
|
-
## Enable a runner in project
|
|
265
|
-
|
|
266
|
-
Enable an available specific runner in the project.
|
|
267
|
-
|
|
268
|
-
```
|
|
269
|
-
POST /projects/:id/runners
|
|
270
|
-
```
|
|
271
|
-
|
|
272
|
-
| Attribute | Type | Required | Description |
|
|
273
|
-
|-------------|---------|----------|---------------------|
|
|
274
|
-
| `id` | integer | yes | The ID of a project |
|
|
275
|
-
| `runner_id` | integer | yes | The ID of a runner |
|
|
276
|
-
|
|
277
|
-
```
|
|
278
|
-
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/9/runners" --form "runner_id=9"
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
Example response:
|
|
282
|
-
|
|
283
|
-
```json
|
|
284
|
-
{
|
|
285
|
-
"active": true,
|
|
286
|
-
"description": "test-2016-02-01",
|
|
287
|
-
"id": 9,
|
|
288
|
-
"is_shared": false,
|
|
289
|
-
"name": null
|
|
290
|
-
}
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
## Disable a runner from project
|
|
294
|
-
|
|
295
|
-
Disable a specific runner from the project. It works only if the project isn't
|
|
296
|
-
the only project associated with the specified runner. If so, an error is
|
|
297
|
-
returned. Use the [Remove a runner](#remove-a-runner) call instead.
|
|
298
|
-
|
|
299
|
-
```
|
|
300
|
-
DELETE /projects/:id/runners/:runner_id
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
| Attribute | Type | Required | Description |
|
|
304
|
-
|-------------|---------|----------|---------------------|
|
|
305
|
-
| `id` | integer | yes | The ID of a project |
|
|
306
|
-
| `runner_id` | integer | yes | The ID of a runner |
|
|
307
|
-
|
|
308
|
-
```
|
|
309
|
-
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/9/runners/9"
|
|
310
|
-
```
|
|
311
|
-
|
|
312
|
-
Example response:
|
|
313
|
-
|
|
314
|
-
```json
|
|
315
|
-
{
|
|
316
|
-
"active": true,
|
|
317
|
-
"description": "test-2016-02-01",
|
|
318
|
-
"id": 9,
|
|
319
|
-
"is_shared": false,
|
|
320
|
-
"name": null
|
|
321
|
-
}
|
|
322
|
-
```
|