Update documentation and expose ID
This commit is contained in:
Kamil Trzcinski
parent
140b51ce98
commit
b565ee4912
|
|
@ -12,7 +12,6 @@ following locations:
|
|||
- [Branches](branches.md)
|
||||
- [Broadcast Messages](broadcast_messages.md)
|
||||
- [Builds](builds.md)
|
||||
- [Build Triggers](build_triggers.md)
|
||||
- [Build Variables](build_variables.md)
|
||||
- [Commits](commits.md)
|
||||
- [Deployments](deployments.md)
|
||||
|
|
@ -33,6 +32,7 @@ following locations:
|
|||
- [Notes](notes.md) (comments)
|
||||
- [Notification settings](notification_settings.md)
|
||||
- [Pipelines](pipelines.md)
|
||||
- [Pipeline Triggers](pipeline_triggers.md)
|
||||
- [Projects](projects.md) including setting Webhooks
|
||||
- [Project Access Requests](access_requests.md)
|
||||
- [Project Members](members.md)
|
||||
|
|
|
|||
|
|
@ -1,108 +0,0 @@
|
|||
# Build triggers
|
||||
|
||||
You can read more about [triggering builds through the API](../ci/triggers/README.md).
|
||||
|
||||
## List project triggers
|
||||
|
||||
Get a list of project's build triggers.
|
||||
|
||||
```
|
||||
GET /projects/:id/triggers
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|-----------|---------|----------|---------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
|
||||
```
|
||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers"
|
||||
```
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"created_at": "2015-12-23T16:24:34.716Z",
|
||||
"deleted_at": null,
|
||||
"last_used": "2016-01-04T15:41:21.986Z",
|
||||
"token": "fbdb730c2fbdb095a0862dbd8ab88b",
|
||||
"updated_at": "2015-12-23T16:24:34.716Z"
|
||||
},
|
||||
{
|
||||
"created_at": "2015-12-23T16:25:56.760Z",
|
||||
"deleted_at": null,
|
||||
"last_used": null,
|
||||
"token": "7b9148c158980bbd9bcea92c17522d",
|
||||
"updated_at": "2015-12-23T16:25:56.760Z"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## Get trigger details
|
||||
|
||||
Get details of project's build trigger.
|
||||
|
||||
```
|
||||
GET /projects/:id/triggers/:token
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|-----------|---------|----------|--------------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
| `token` | string | yes | The `token` of a trigger |
|
||||
|
||||
```
|
||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"created_at": "2015-12-23T16:25:56.760Z",
|
||||
"deleted_at": null,
|
||||
"last_used": null,
|
||||
"token": "7b9148c158980bbd9bcea92c17522d",
|
||||
"updated_at": "2015-12-23T16:25:56.760Z"
|
||||
}
|
||||
```
|
||||
|
||||
## Create a project trigger
|
||||
|
||||
Create a build trigger for a project.
|
||||
|
||||
```
|
||||
POST /projects/:id/triggers
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|-----------|---------|----------|--------------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
|
||||
```
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers"
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"created_at": "2016-01-07T09:53:58.235Z",
|
||||
"deleted_at": null,
|
||||
"last_used": null,
|
||||
"token": "6d056f63e50fe6f8c5f8f4aa10edb7",
|
||||
"updated_at": "2016-01-07T09:53:58.235Z"
|
||||
}
|
||||
```
|
||||
|
||||
## Remove a project trigger
|
||||
|
||||
Remove a project's build trigger.
|
||||
|
||||
```
|
||||
DELETE /projects/:id/triggers/:token
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|-----------|---------|----------|--------------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
| `token` | string | yes | The `token` of a trigger |
|
||||
|
||||
```
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"
|
||||
```
|
||||
|
|
@ -0,0 +1,170 @@
|
|||
# Pipeline triggers
|
||||
|
||||
You can read more about [triggering pipelines through the API](../ci/triggers/README.md).
|
||||
|
||||
## List project triggers
|
||||
|
||||
Get a list of project's build triggers.
|
||||
|
||||
```
|
||||
GET /projects/:id/triggers
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|-----------|---------|----------|---------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
|
||||
```
|
||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers"
|
||||
```
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 10,
|
||||
"description": "my trigger",
|
||||
"created_at": "2016-01-07T09:53:58.235Z",
|
||||
"deleted_at": null,
|
||||
"last_used": null,
|
||||
"token": "6d056f63e50fe6f8c5f8f4aa10edb7",
|
||||
"updated_at": "2016-01-07T09:53:58.235Z",
|
||||
"owner": null
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## Get trigger details
|
||||
|
||||
Get details of project's build trigger.
|
||||
|
||||
```
|
||||
GET /projects/:id/triggers/:trigger_id
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|-----------|---------|----------|--------------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
| `token` | string | yes | The `token` of a trigger |
|
||||
|
||||
```
|
||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/5"
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 10,
|
||||
"description": "my trigger",
|
||||
"created_at": "2016-01-07T09:53:58.235Z",
|
||||
"deleted_at": null,
|
||||
"last_used": null,
|
||||
"token": "6d056f63e50fe6f8c5f8f4aa10edb7",
|
||||
"updated_at": "2016-01-07T09:53:58.235Z",
|
||||
"owner": null
|
||||
}
|
||||
```
|
||||
|
||||
## Create a project trigger
|
||||
|
||||
Create a trigger for a project.
|
||||
|
||||
```
|
||||
POST /projects/:id/triggers
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|---------------|---------|----------|--------------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
| `description` | string | yes | The trigger name |
|
||||
|
||||
```
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" -F description="my description" "https://gitlab.example.com/api/v4/projects/1/triggers"
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 10,
|
||||
"description": "my trigger",
|
||||
"created_at": "2016-01-07T09:53:58.235Z",
|
||||
"deleted_at": null,
|
||||
"last_used": null,
|
||||
"token": "6d056f63e50fe6f8c5f8f4aa10edb7",
|
||||
"updated_at": "2016-01-07T09:53:58.235Z",
|
||||
"owner": null
|
||||
}
|
||||
```
|
||||
|
||||
## Update a project trigger
|
||||
|
||||
Update a trigger for a project.
|
||||
|
||||
```
|
||||
PUT /projects/:id/triggers/:trigger_id
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|---------------|---------|----------|--------------------------|
|
||||
| `trigger_id` | integer | yes | The trigger id |
|
||||
| `description` | string | no | The trigger name |
|
||||
|
||||
```
|
||||
curl --request PUT -F description="my description" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/10"
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 10,
|
||||
"description": "my trigger",
|
||||
"created_at": "2016-01-07T09:53:58.235Z",
|
||||
"deleted_at": null,
|
||||
"last_used": null,
|
||||
"token": "6d056f63e50fe6f8c5f8f4aa10edb7",
|
||||
"updated_at": "2016-01-07T09:53:58.235Z",
|
||||
"owner": null
|
||||
}
|
||||
```
|
||||
|
||||
## Take ownership of a project trigger
|
||||
|
||||
Update an owner of a project trigger.
|
||||
|
||||
```
|
||||
POST /projects/:id/triggers/:trigger_id/take
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|---------------|---------|----------|--------------------------|
|
||||
| `trigger_id` | integer | yes | The trigger id |
|
||||
|
||||
```
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/10/take"
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 10,
|
||||
"description": "my trigger",
|
||||
"created_at": "2016-01-07T09:53:58.235Z",
|
||||
"deleted_at": null,
|
||||
"last_used": null,
|
||||
"token": "6d056f63e50fe6f8c5f8f4aa10edb7",
|
||||
"updated_at": "2016-01-07T09:53:58.235Z",
|
||||
"owner": null
|
||||
}
|
||||
```
|
||||
|
||||
## Remove a project trigger
|
||||
|
||||
Remove a project's build trigger.
|
||||
|
||||
```
|
||||
DELETE /projects/:id/triggers/:trigger_id
|
||||
```
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|----------------|---------|----------|--------------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
| `trigger_id` | integer | yes | The trigger id |
|
||||
|
||||
```
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/5"
|
||||
```
|
||||
|
|
@ -639,6 +639,7 @@ module API
|
|||
end
|
||||
|
||||
class Trigger < Grape::Entity
|
||||
expose :id
|
||||
expose :token, :description
|
||||
expose :created_at, :updated_at, :deleted_at, :last_used
|
||||
expose :owner, using: Entities::UserBasic
|
||||
|
|
|
|||
Loading…
Reference in New Issue