kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Add mofications to triggers API documentation [ci skip]

Browse source
This commit is contained in:
Tomasz Maczukin 2016-01-14 11:08:33 +01:00
parent d8359a4f6e
commit c5b429f099
1 changed files with 12 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
doc/api/build_triggers.md
View file

@ -1,27 +1,23 @@
# Build triggers
You can read more about [triggering builds through the API](../ci/triggers/README.md).
## List project triggers
Get a list of project triggers
Get a list of project's build triggers.
```
GET /projects/:id/triggers
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
| id | integer | yes | The ID of a project |
### Example of request
| `id` | integer | yes | The ID of a project |
```
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers"
```
### Example of response
```json
[
{
@ -43,27 +39,21 @@ curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3
## Get trigger details
Get details of trigger of a project
Get details of project's build trigger.
```
GET /projects/:id/triggers/:token
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|--------------------------|
| id | integer | yes | The ID of a project |
| token | string | yes | The `token` of a project |
### Example of request
| `id` | integer | yes | The ID of a project |
| `token` | string | yes | The `token` of a trigger |
```
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"
```
### Example of response
```json
{
"created_at": "2015-12-23T16:25:56.760Z",
@ -76,26 +66,20 @@ curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3
## Create a project trigger
Create a trigger for a project
Create a build trigger for a project.
```
POST /projects/:id/triggers
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|--------------------------|
| id | integer | yes | The ID of a project |
### Example of request
| `id` | integer | yes | The ID of a project |
```
curl -X POST -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers"
```
### Example of response
```json
{
"created_at": "2016-01-07T09:53:58.235Z",
@ -108,20 +92,16 @@ curl -X POST -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.co
## Remove a project trigger
Remove a trigger of a project
Remove a project's build trigger.
```
DELETE /projects/:id/triggers/:token
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|--------------------------|
| id | integer | yes | The ID of a project |
| token | string | yes | The `token` of a project |
### Example of request
| `id` | integer | yes | The ID of a project |
| `token` | string | yes | The `token` of a project |
```
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"