Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
19422347
Commit
19422347
authored
Mar 06, 2017
by
Z.J. van de Weg
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Rename build to job in the docs
parent
e25bb81b
Changes
6
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
113 additions
and
113 deletions
+113
-113
doc/api/groups.md
doc/api/groups.md
+10
-10
doc/api/jobs.md
doc/api/jobs.md
+56
-56
doc/api/pipelines.md
doc/api/pipelines.md
+2
-2
doc/api/projects.md
doc/api/projects.md
+26
-26
doc/api/services.md
doc/api/services.md
+14
-14
lib/api/services.rb
lib/api/services.rb
+5
-5
No files found.
doc/api/groups.md
View file @
19422347
...
@@ -84,7 +84,7 @@ Example response:
...
@@ -84,7 +84,7 @@ Example response:
"issues_enabled"
:
true
,
"issues_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"wiki_enabled"
:
true
,
"wiki_enabled"
:
true
,
"
build
s_enabled"
:
true
,
"
job
s_enabled"
:
true
,
"snippets_enabled"
:
true
,
"snippets_enabled"
:
true
,
"created_at"
:
"2016-04-05T21:40:50.169Z"
,
"created_at"
:
"2016-04-05T21:40:50.169Z"
,
"last_activity_at"
:
"2016-04-06T16:52:08.432Z"
,
"last_activity_at"
:
"2016-04-06T16:52:08.432Z"
,
...
@@ -100,7 +100,7 @@ Example response:
...
@@ -100,7 +100,7 @@ Example response:
"star_count"
:
1
,
"star_count"
:
1
,
"forks_count"
:
0
,
"forks_count"
:
0
,
"open_issues_count"
:
3
,
"open_issues_count"
:
3
,
"public_
build
s"
:
true
,
"public_
job
s"
:
true
,
"shared_with_groups"
:
[],
"shared_with_groups"
:
[],
"request_access_enabled"
:
false
"request_access_enabled"
:
false
}
}
...
@@ -158,7 +158,7 @@ Example response:
...
@@ -158,7 +158,7 @@ Example response:
"issues_enabled"
:
true
,
"issues_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"wiki_enabled"
:
true
,
"wiki_enabled"
:
true
,
"
build
s_enabled"
:
true
,
"
job
s_enabled"
:
true
,
"snippets_enabled"
:
false
,
"snippets_enabled"
:
false
,
"container_registry_enabled"
:
true
,
"container_registry_enabled"
:
true
,
"created_at"
:
"2016-06-17T07:47:25.578Z"
,
"created_at"
:
"2016-06-17T07:47:25.578Z"
,
...
@@ -175,7 +175,7 @@ Example response:
...
@@ -175,7 +175,7 @@ Example response:
"star_count"
:
0
,
"star_count"
:
0
,
"forks_count"
:
0
,
"forks_count"
:
0
,
"open_issues_count"
:
3
,
"open_issues_count"
:
3
,
"public_
build
s"
:
true
,
"public_
job
s"
:
true
,
"shared_with_groups"
:
[],
"shared_with_groups"
:
[],
"request_access_enabled"
:
false
"request_access_enabled"
:
false
},
},
...
@@ -196,7 +196,7 @@ Example response:
...
@@ -196,7 +196,7 @@ Example response:
"issues_enabled"
:
true
,
"issues_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"wiki_enabled"
:
true
,
"wiki_enabled"
:
true
,
"
build
s_enabled"
:
true
,
"
job
s_enabled"
:
true
,
"snippets_enabled"
:
false
,
"snippets_enabled"
:
false
,
"container_registry_enabled"
:
true
,
"container_registry_enabled"
:
true
,
"created_at"
:
"2016-06-17T07:47:24.661Z"
,
"created_at"
:
"2016-06-17T07:47:24.661Z"
,
...
@@ -213,7 +213,7 @@ Example response:
...
@@ -213,7 +213,7 @@ Example response:
"star_count"
:
0
,
"star_count"
:
0
,
"forks_count"
:
0
,
"forks_count"
:
0
,
"open_issues_count"
:
8
,
"open_issues_count"
:
8
,
"public_
build
s"
:
true
,
"public_
job
s"
:
true
,
"shared_with_groups"
:
[],
"shared_with_groups"
:
[],
"request_access_enabled"
:
false
"request_access_enabled"
:
false
}
}
...
@@ -236,7 +236,7 @@ Example response:
...
@@ -236,7 +236,7 @@ Example response:
"issues_enabled"
:
true
,
"issues_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"wiki_enabled"
:
true
,
"wiki_enabled"
:
true
,
"
build
s_enabled"
:
true
,
"
job
s_enabled"
:
true
,
"snippets_enabled"
:
false
,
"snippets_enabled"
:
false
,
"container_registry_enabled"
:
true
,
"container_registry_enabled"
:
true
,
"created_at"
:
"2016-06-17T07:47:27.089Z"
,
"created_at"
:
"2016-06-17T07:47:27.089Z"
,
...
@@ -253,7 +253,7 @@ Example response:
...
@@ -253,7 +253,7 @@ Example response:
"star_count"
:
0
,
"star_count"
:
0
,
"forks_count"
:
0
,
"forks_count"
:
0
,
"open_issues_count"
:
4
,
"open_issues_count"
:
4
,
"public_
build
s"
:
true
,
"public_
job
s"
:
true
,
"shared_with_groups"
:
[
"shared_with_groups"
:
[
{
{
"group_id"
:
4
,
"group_id"
:
4
,
...
@@ -359,7 +359,7 @@ Example response:
...
@@ -359,7 +359,7 @@ Example response:
"issues_enabled"
:
true
,
"issues_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"wiki_enabled"
:
true
,
"wiki_enabled"
:
true
,
"
build
s_enabled"
:
true
,
"
job
s_enabled"
:
true
,
"snippets_enabled"
:
true
,
"snippets_enabled"
:
true
,
"created_at"
:
"2016-04-05T21:40:50.169Z"
,
"created_at"
:
"2016-04-05T21:40:50.169Z"
,
"last_activity_at"
:
"2016-04-06T16:52:08.432Z"
,
"last_activity_at"
:
"2016-04-06T16:52:08.432Z"
,
...
@@ -375,7 +375,7 @@ Example response:
...
@@ -375,7 +375,7 @@ Example response:
"star_count"
:
1
,
"star_count"
:
1
,
"forks_count"
:
0
,
"forks_count"
:
0
,
"open_issues_count"
:
3
,
"open_issues_count"
:
3
,
"public_
build
s"
:
true
,
"public_
job
s"
:
true
,
"shared_with_groups"
:
[],
"shared_with_groups"
:
[],
"request_access_enabled"
:
false
"request_access_enabled"
:
false
}
}
...
...
doc/api/
build
s.md
→
doc/api/
job
s.md
View file @
19422347
This diff is collapsed.
Click to expand it.
doc/api/pipelines.md
View file @
19422347
...
@@ -127,7 +127,7 @@ Example of response
...
@@ -127,7 +127,7 @@ Example of response
}
}
```
```
## Retry
build
s in a pipeline
## Retry
job
s in a pipeline
> [Introduced][ce-5837] in GitLab 8.11
> [Introduced][ce-5837] in GitLab 8.11
...
@@ -173,7 +173,7 @@ Response:
...
@@ -173,7 +173,7 @@ Response:
}
}
```
```
## Cancel a pipelines
builds
## Cancel a pipelines
jobs
> [Introduced][ce-5837] in GitLab 8.11
> [Introduced][ce-5837] in GitLab 8.11
...
...
doc/api/projects.md
View file @
19422347
This diff is collapsed.
Click to expand it.
doc/api/services.md
View file @
19422347
...
@@ -70,7 +70,7 @@ GET /projects/:id/services/assembla
...
@@ -70,7 +70,7 @@ GET /projects/:id/services/assembla
## Atlassian Bamboo CI
## Atlassian Bamboo CI
A continuous integration and
build
server
A continuous integration and
job
server
### Create/Edit Atlassian Bamboo CI service
### Create/Edit Atlassian Bamboo CI service
...
@@ -85,7 +85,7 @@ PUT /projects/:id/services/bamboo
...
@@ -85,7 +85,7 @@ PUT /projects/:id/services/bamboo
Parameters:
Parameters:
-
`bamboo_url`
(
**required**
) - Bamboo root URL like https://bamboo.example.com
-
`bamboo_url`
(
**required**
) - Bamboo root URL like https://bamboo.example.com
-
`
build_key`
(
**required**
) - Bamboo build
plan key like KEY
-
`
job_key`
(
**required**
) - Bamboo job
plan key like KEY
-
`username`
(
**required**
) - A user with API access, if applicable
-
`username`
(
**required**
) - A user with API access, if applicable
-
`password`
(
**required**
)
-
`password`
(
**required**
)
...
@@ -114,13 +114,13 @@ Continuous integration and deployments
...
@@ -114,13 +114,13 @@ Continuous integration and deployments
Set Buildkite service for a project.
Set Buildkite service for a project.
```
```
PUT /projects/:id/services/
build
kite
PUT /projects/:id/services/
job
kite
```
```
Parameters:
Parameters:
-
`token`
(
**required**
) - Buildkite project GitLab token
-
`token`
(
**required**
) - Buildkite project GitLab token
-
`project_url`
(
**required**
) - https://
build
kite.com/example/project
-
`project_url`
(
**required**
) - https://
job
kite.com/example/project
-
`enable_ssl_verification`
(optional) - Enable SSL verification
-
`enable_ssl_verification`
(optional) - Enable SSL verification
### Delete Buildkite service
### Delete Buildkite service
...
@@ -128,7 +128,7 @@ Parameters:
...
@@ -128,7 +128,7 @@ Parameters:
Delete Buildkite service for a project.
Delete Buildkite service for a project.
```
```
DELETE /projects/:id/services/
build
kite
DELETE /projects/:id/services/
job
kite
```
```
### Get Buildkite service settings
### Get Buildkite service settings
...
@@ -136,19 +136,19 @@ DELETE /projects/:id/services/buildkite
...
@@ -136,19 +136,19 @@ DELETE /projects/:id/services/buildkite
Get Buildkite service settings for a project.
Get Buildkite service settings for a project.
```
```
GET /projects/:id/services/
build
kite
GET /projects/:id/services/
job
kite
```
```
## Build-Emails
## Build-Emails
Get emails for GitLab CI
build
s.
Get emails for GitLab CI
job
s.
### Create/Edit Build-Emails service
### Create/Edit Build-Emails service
Set Build-Emails service for a project.
Set Build-Emails service for a project.
```
```
PUT /projects/:id/services/
build
s-email
PUT /projects/:id/services/
job
s-email
```
```
Parameters:
Parameters:
...
@@ -157,23 +157,23 @@ Parameters:
...
@@ -157,23 +157,23 @@ Parameters:
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`recipients`
| string | yes | Comma-separated list of recipient email addresses |
|
`recipients`
| string | yes | Comma-separated list of recipient email addresses |
|
`add_pusher`
| boolean | no | Add pusher to recipients list |
|
`add_pusher`
| boolean | no | Add pusher to recipients list |
|
`notify_only_broken_
builds`
| boolean | no | Notify only broken build
s |
|
`notify_only_broken_
jobs`
| boolean | no | Notify only broken job
s |
### Delete
Build
-Emails service
### Delete
Job
-Emails service
Delete Build-Emails service for a project.
Delete Build-Emails service for a project.
```
```
DELETE /projects/:id/services/
build
s-email
DELETE /projects/:id/services/
job
s-email
```
```
### Get
Build
-Emails service settings
### Get
Job
-Emails service settings
Get Build-Emails service settings for a project.
Get Build-Emails service settings for a project.
```
```
GET /projects/:id/services/
build
s-email
GET /projects/:id/services/
job
s-email
```
```
## Campfire
## Campfire
...
@@ -580,7 +580,7 @@ Parameters:
...
@@ -580,7 +580,7 @@ Parameters:
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`recipients`
| string | yes | Comma-separated list of recipient email addresses |
|
`recipients`
| string | yes | Comma-separated list of recipient email addresses |
|
`add_pusher`
| boolean | no | Add pusher to recipients list |
|
`add_pusher`
| boolean | no | Add pusher to recipients list |
|
`notify_only_broken_
build
s`
| boolean | no | Notify only broken pipelines |
|
`notify_only_broken_
job
s`
| boolean | no | Notify only broken pipelines |
### Delete Pipeline-Emails service
### Delete Pipeline-Emails service
...
...
lib/api/services.rb
View file @
19422347
...
@@ -122,9 +122,9 @@ module API
...
@@ -122,9 +122,9 @@ module API
},
},
{
{
required:
false
,
required:
false
,
name: :notify_only_broken_
build
s
,
name: :notify_only_broken_
job
s
,
type:
Boolean
,
type:
Boolean
,
desc:
'Notify only broken
build
s'
desc:
'Notify only broken
job
s'
}
}
],
],
'campfire'
=>
[
'campfire'
=>
[
...
@@ -403,9 +403,9 @@ module API
...
@@ -403,9 +403,9 @@ module API
},
},
{
{
required:
false
,
required:
false
,
name: :notify_only_broken_
build
s
,
name: :notify_only_broken_
job
s
,
type:
Boolean
,
type:
Boolean
,
desc:
'Notify only broken
build
s'
desc:
'Notify only broken
job
s'
}
}
],
],
'pivotaltracker'
=>
[
'pivotaltracker'
=>
[
...
@@ -611,7 +611,7 @@ module API
...
@@ -611,7 +611,7 @@ module API
desc
"Set
#{
service_slug
}
service for project"
desc
"Set
#{
service_slug
}
service for project"
params
do
params
do
service_classes
.
each
do
|
service
|
service_classes
.
each
do
|
service
|
event_names
=
service
.
try
(
:event_names
)
||
[]
event_names
=
service
.
try
(
:event_names
)
||
next
event_names
.
each
do
|
event_name
|
event_names
.
each
do
|
event_name
|
services
[
service
.
to_param
.
tr
(
"_"
,
"-"
)]
<<
{
services
[
service
.
to_param
.
tr
(
"_"
,
"-"
)]
<<
{
required:
false
,
required:
false
,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment