diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2016-12-12 16:27:52 +0300 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2016-12-12 16:27:52 +0300 |
| commit | 8d0645c2ce3769268020ad6f8e51db07fb1e4bc6 (patch) | |
| tree | aa5c1e30d74a32885dc8eb0a37dd358335239466 /doc/api/services.md | |
| parent | 593c912151eaef865d31fc2a8307ef6d337c2349 (diff) | |
Grapify the service API
Diffstat (limited to 'doc/api/services.md')
| -rw-r--r-- | doc/api/services.md | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/doc/api/services.md b/doc/api/services.md index acb54448664..3dad953cd1e 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -153,9 +153,12 @@ PUT /projects/:id/services/builds-email Parameters: -- `recipients` (**required**) - Comma-separated list of recipient email addresses -- `add_pusher` (optional) - Add pusher to recipients list -- `notify_only_broken_builds` (optional) -Notify only broken builds +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `recipients` | string | yes | Comma-separated list of recipient email addresses | +| `add_pusher` | boolean | no | Add pusher to recipients list | +| `notify_only_broken_builds` | boolean | no | Notify only broken builds | + ### Delete Build-Emails service @@ -538,7 +541,10 @@ PUT /projects/:id/services/mattermost-slash-commands Parameters: -- `token` (**required**) - The Mattermost token +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `token` | string | yes | The Mattermost token | + ### Delete Mattermost Slash Command service @@ -570,8 +576,12 @@ PUT /projects/:id/services/pipelines-email Parameters: -- `recipients` (**required**) - Comma-separated list of recipient email addresses -- `notify_only_broken_builds` (optional) -Notify only broken pipelines +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `recipients` | string | yes | Comma-separated list of recipient email addresses | +| `add_pusher` | boolean | no | Add pusher to recipients list | +| `notify_only_broken_builds` | boolean | no | Notify only broken pipelines | + ### Delete Pipeline-Emails service |