Skip to content

G
gitlab-ce
Commit 0d7f9762 authored by Mark Fletcher's avatar Mark Fletcher
Browse files
Options

Update parameter formatting across Service API docs

parent 1e72dd10
Hide whitespace changes
Inline Side-by-side
Showing with 102 additions and 62 deletions
doc/api/services.md
View file @ 0d7f9762
# Services API # Services API
>**Note:** This API requires an access token with Master or Owner permissions
## Asana ## Asana
Asana - Teamwork without email Asana - Teamwork without email
...@@ -16,8 +18,10 @@ PUT /projects/:id/services/asana ...@@ -16,8 +18,10 @@ PUT /projects/:id/services/asana
Parameters: Parameters:
- `api_key` (**required**) - User API token. User must have access to task, all comments will be attributed to this user. | Parameter | Type | Required | Description |
- `restrict_to_branch` (optional) - Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches. | --------- | ---- | -------- | ----------- |
| `api_key` | string | true | User API token. User must have access to task, all comments will be attributed to this user. |
| `restrict_to_branch` | string | false | Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches. |
### Delete Asana service ### Delete Asana service
...@@ -49,8 +53,10 @@ PUT /projects/:id/services/assembla ...@@ -49,8 +53,10 @@ PUT /projects/:id/services/assembla
Parameters: Parameters:
- `token` (**required**) | Parameter | Type | Required | Description |
- `subdomain` (optional) | --------- | ---- | -------- | ----------- |
| `token` | string | true | The authentication token
| `subdomain` | string | false | The subdomain setting |
### Delete Assembla service ### Delete Assembla service
...@@ -84,10 +90,12 @@ PUT /projects/:id/services/bamboo ...@@ -84,10 +90,12 @@ PUT /projects/:id/services/bamboo
Parameters: Parameters:
- `bamboo_url` (**required**) - Bamboo root URL like https://bamboo.example.com | Parameter | Type | Required | Description |
- `build_key` (**required**) - Bamboo build plan key like KEY | --------- | ---- | -------- | ----------- |
- `username` (**required**) - A user with API access, if applicable | `bamboo_url` | string | true | Bamboo root URL like https://bamboo.example.com |
- `password` (**required**) | `build_key` | string | true | Bamboo build plan key like KEY |
| `username` | string | true | A user with API access, if applicable |
| `password` | string | true | Password of the user |
### Delete Atlassian Bamboo CI service ### Delete Atlassian Bamboo CI service
...@@ -119,9 +127,11 @@ PUT /projects/:id/services/buildkite ...@@ -119,9 +127,11 @@ PUT /projects/:id/services/buildkite
Parameters: Parameters:
- `token` (**required**) - Buildkite project GitLab token | Parameter | Type | Required | Description |
- `project_url` (**required**) - https://buildkite.com/example/project | --------- | ---- | -------- | ----------- |
- `enable_ssl_verification` (optional) - Enable SSL verification | `token` | string | true | Buildkite project GitLab token |
| `project_url` | string | true | https://buildkite.com/example/project |
| `enable_ssl_verification` | boolean | false | Enable SSL verification |
### Delete Buildkite service ### Delete Buildkite service
...@@ -153,9 +163,11 @@ PUT /projects/:id/services/campfire ...@@ -153,9 +163,11 @@ PUT /projects/:id/services/campfire
Parameters: Parameters:
- `token` (**required**) | Parameter | Type | Required | Description |
- `subdomain` (optional) | --------- | ---- | -------- | ----------- |
- `room` (optional) | `token` | string | true | Campfire token |
| `subdomain` | string | false | Campfire subdomain |
| `room` | string | false | Campfire room |
### Delete Campfire service ### Delete Campfire service
...@@ -187,11 +199,13 @@ PUT /projects/:id/services/custom-issue-tracker ...@@ -187,11 +199,13 @@ PUT /projects/:id/services/custom-issue-tracker
Parameters: Parameters:
- `new_issue_url` (**required**) - New Issue url | Parameter | Type | Required | Description |
- `issues_url` (**required**) - Issue url | --------- | ---- | -------- | ----------- |
- `project_url` (**required**) - Project url | `new_issue_url` | string | true | New Issue url
- `description` (optional) - Custom issue tracker | `issues_url` | string | true | Issue url
- `title` (optional) - Custom Issue Tracker | `project_url` | string | true | Project url
| `description` | string | false | Description
| `title` | string | false | Title
### Delete Custom Issue Tracker service ### Delete Custom Issue Tracker service
...@@ -223,9 +237,11 @@ PUT /projects/:id/services/drone-ci ...@@ -223,9 +237,11 @@ PUT /projects/:id/services/drone-ci
Parameters: Parameters:
- `token` (**required**) - Drone CI project specific token | Parameter | Type | Required | Description |
- `drone_url` (**required**) - http://drone.example.com | --------- | ---- | -------- | ----------- |
- `enable_ssl_verification` (optional) - Enable SSL verification | `token` | string | true | Drone CI project specific token |
| `drone_url` | string | true | http://drone.example.com |
| `enable_ssl_verification` | boolean | false | Enable SSL verification |
### Delete Drone CI service ### Delete Drone CI service
...@@ -257,9 +273,11 @@ PUT /projects/:id/services/emails-on-push ...@@ -257,9 +273,11 @@ PUT /projects/:id/services/emails-on-push
Parameters: Parameters:
- `recipients` (**required**) - Emails separated by whitespace | Parameter | Type | Required | Description |
- `disable_diffs` (optional) - Disable code diffs | --------- | ---- | -------- | ----------- |
- `send_from_committer_email` (optional) - Send from committer | `recipients` | string | true | Emails separated by whitespace |
| `disable_diffs` | boolean | false | Disable code diffs |
| `send_from_committer_email` | boolean | false | Send from committer |
### Delete Emails on push service ### Delete Emails on push service
...@@ -291,7 +309,9 @@ PUT /projects/:id/services/external-wiki ...@@ -291,7 +309,9 @@ PUT /projects/:id/services/external-wiki
Parameters: Parameters:
- `external_wiki_url` (**required**) - The URL of the external Wiki | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `external_wiki_url` | string | true | The URL of the external Wiki |
### Delete External Wiki service ### Delete External Wiki service
...@@ -323,7 +343,9 @@ PUT /projects/:id/services/flowdock ...@@ -323,7 +343,9 @@ PUT /projects/:id/services/flowdock
Parameters: Parameters:
- `token` (**required**) - Flowdock Git source token | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `token` | string | true | Flowdock Git source token |
### Delete Flowdock service ### Delete Flowdock service
...@@ -355,8 +377,10 @@ PUT /projects/:id/services/gemnasium ...@@ -355,8 +377,10 @@ PUT /projects/:id/services/gemnasium
Parameters: Parameters:
- `api_key` (**required**) - Your personal API KEY on gemnasium.com | Parameter | Type | Required | Description |
- `token` (**required**) - The project's slug on gemnasium.com | --------- | ---- | -------- | ----------- |
| `api_key` | string | true | Your personal API KEY on gemnasium.com |
| `token` | string | true | The project's slug on gemnasium.com |
### Delete Gemnasium service ### Delete Gemnasium service
...@@ -388,12 +412,14 @@ PUT /projects/:id/services/hipchat ...@@ -388,12 +412,14 @@ PUT /projects/:id/services/hipchat
Parameters: Parameters:
- `token` (**required**) - Room token | Parameter | Type | Required | Description |
- `color` (optional) | --------- | ---- | -------- | ----------- |
- `notify` (optional) | `token` | string | true | Room token |
- `room` (optional) - Room name or ID | `color` | string | false | The room color |
- `api_version` (optional) - Leave blank for default (v2) | `notify` | boolean | false | Enable notifications |
- `server` (optional) - Leave blank for default. https://hipchat.example.com | `room` | string | false |Room name or ID |
| `api_version` | string | false | Leave blank for default (v2) |
| `server` | string | false | Leave blank for default. https://hipchat.example.com |
### Delete HipChat service ### Delete HipChat service
...@@ -427,11 +453,13 @@ PUT /projects/:id/services/irker ...@@ -427,11 +453,13 @@ PUT /projects/:id/services/irker
Parameters: Parameters:
- `recipients` (**required**) - Recipients/channels separated by whitespaces | Parameter | Type | Required | Description |
- `default_irc_uri` (optional) - irc://irc.network.net:6697/ | --------- | ---- | -------- | ----------- |
- `server_port` (optional) - 6659 | `recipients` | string | true | Recipients/channels separated by whitespaces |
- `server_host` (optional) - localhost | `default_irc_uri` | string | false | irc://irc.network.net:6697/ |
- `colorize_messages` (optional) | `server_host` | string | false | localhost |
| `server_port` | integer | false | 6659 |
| `colorize_messages` | boolean | false | Colorize messages |
### Delete Irker (IRC gateway) service ### Delete Irker (IRC gateway) service
...@@ -474,7 +502,9 @@ Set JIRA service for a project. ...@@ -474,7 +502,9 @@ Set JIRA service for a project.
PUT /projects/:id/services/jira PUT /projects/:id/services/jira
``` ```
| Attribute | Type | Required | Description | Parameters:
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | yes | The URL to the JIRA project which is being linked to this GitLab project, e.g., `https://jira.example.com`. | | `url` | string | yes | The URL to the JIRA project which is being linked to this GitLab project, e.g., `https://jira.example.com`. |
| `project_key` | string | yes | The short identifier for your JIRA project, all uppercase, e.g., `PROJ`. | | `project_key` | string | yes | The short identifier for your JIRA project, all uppercase, e.g., `PROJ`. |
...@@ -569,7 +599,7 @@ PUT /projects/:id/services/slack-slash-commands ...@@ -569,7 +599,7 @@ PUT /projects/:id/services/slack-slash-commands
Parameters: Parameters:
| Attribute | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `token` | string | yes | The Slack token | | `token` | string | yes | The Slack token |
...@@ -604,7 +634,7 @@ PUT /projects/:id/services/mattermost-slash-commands ...@@ -604,7 +634,7 @@ PUT /projects/:id/services/mattermost-slash-commands
Parameters: Parameters:
| Attribute | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `token` | string | yes | The Mattermost token | | `token` | string | yes | The Mattermost token |
| `username` | string | no | The username to use to post the message | | `username` | string | no | The username to use to post the message |
...@@ -665,7 +695,7 @@ PUT /projects/:id/services/pipelines-email ...@@ -665,7 +695,7 @@ PUT /projects/:id/services/pipelines-email
Parameters: Parameters:
| Attribute | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `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 |
...@@ -701,8 +731,10 @@ PUT /projects/:id/services/pivotaltracker ...@@ -701,8 +731,10 @@ PUT /projects/:id/services/pivotaltracker
Parameters: Parameters:
- `token` (**required**) | Parameter | Type | Required | Description |
- `restrict_to_branch` (optional) - Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches. | --------- | ---- | -------- | ----------- |
| `token` | string | true | The PivotalTracker token |
| `restrict_to_branch` | boolean | false | Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches. |
### Delete PivotalTracker service ### Delete PivotalTracker service
...@@ -734,11 +766,13 @@ PUT /projects/:id/services/pushover ...@@ -734,11 +766,13 @@ PUT /projects/:id/services/pushover
Parameters: Parameters:
- `api_key` (**required**) - Your application key | Parameter | Type | Required | Description |
- `user_key` (**required**) - Your user key | --------- | ---- | -------- | ----------- |
- `priority` (**required**) | `api_key` | string | true | Your application key |
- `device` (optional) - Leave blank for all active devices | `user_key` | string | true | Your user key |
- `sound` (optional) | `priority` | string | true | The priority |
| `device` | string | false | Leave blank for all active devices |
| `sound` | string | false | The sound of the notification |
### Delete Pushover service ### Delete Pushover service
...@@ -770,10 +804,12 @@ PUT /projects/:id/services/redmine ...@@ -770,10 +804,12 @@ PUT /projects/:id/services/redmine
Parameters: Parameters:
- `new_issue_url` (**required**) - New Issue url | Parameter | Type | Required | Description |
- `project_url` (**required**) - Project url | --------- | ---- | -------- | ----------- |
- `issues_url` (**required**) - Issue url | `new_issue_url` | string | true | New Issue url |
- `description` (optional) - Redmine issue tracker | `project_url` | string | true | Project url |
| `issues_url` | string | true | Issue url |
| `description` | string | false | Description |
### Delete Redmine service ### Delete Redmine service
...@@ -805,7 +841,7 @@ PUT /projects/:id/services/slack ...@@ -805,7 +841,7 @@ PUT /projects/:id/services/slack
>**Note:** Specific event parameters (e.g. `push_events` flag and `push_channel`) were [introduced in v10.4][11435] >**Note:** Specific event parameters (e.g. `push_events` flag and `push_channel`) were [introduced in v10.4][11435]
#### Parameters Parameters:
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
...@@ -861,7 +897,7 @@ PUT /projects/:id/services/mattermost ...@@ -861,7 +897,7 @@ PUT /projects/:id/services/mattermost
>**Note:** Specific event parameters (e.g. `push_events` flag and `push_channel`) were [introduced in v10.4][11435] >**Note:** Specific event parameters (e.g. `push_events` flag and `push_channel`) were [introduced in v10.4][11435]
#### Parameters Parameters:
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
...@@ -919,10 +955,12 @@ PUT /projects/:id/services/teamcity ...@@ -919,10 +955,12 @@ PUT /projects/:id/services/teamcity
Parameters: Parameters:
- `teamcity_url` (**required**) - TeamCity root URL like https://teamcity.example.com | Parameter | Type | Required | Description |
- `build_type` (**required**) - Build configuration ID | --------- | ---- | -------- | ----------- |
- `username` (**required**) - A user with permissions to trigger a manual build | `teamcity_url` | string | true | TeamCity root URL like https://teamcity.example.com |
- `password` (**required**) | `build_type` | string | true | Build configuration ID |
| `username` | string | true | A user with permissions to trigger a manual build |
| `password` | string | true | The password of the user |
### Delete JetBrains TeamCity CI service ### Delete JetBrains TeamCity CI service
...@@ -960,7 +998,9 @@ PUT /projects/:id/services/mock-ci ...@@ -960,7 +998,9 @@ PUT /projects/:id/services/mock-ci
Parameters: Parameters:
- `mock_service_url` (**required**) - http://localhost:4004 | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `mock_service_url` | string | true | http://localhost:4004 |
### Delete MockCI service ### Delete MockCI service
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7