From d29781bea14d1ae63378c89375e1a537d37d2715 Mon Sep 17 00:00:00 2001 From: TM Lee Date: Tue, 18 Apr 2017 16:19:00 +0800 Subject: [PATCH] [#29801] Add "Slack Slash Commands" to API docs - Reorder slash command api requests, include slack response example - Case fix and added changelog --- ...01-add-slash-slack-commands-to-api-doc.yml | 5 ++ doc/api/services.md | 83 ++++++++++++++++--- 2 files changed, 75 insertions(+), 13 deletions(-) create mode 100644 changelogs/unreleased/29801-add-slash-slack-commands-to-api-doc.yml diff --git a/changelogs/unreleased/29801-add-slash-slack-commands-to-api-doc.yml b/changelogs/unreleased/29801-add-slash-slack-commands-to-api-doc.yml new file mode 100644 index 00000000000..9c5df690085 --- /dev/null +++ b/changelogs/unreleased/29801-add-slash-slack-commands-to-api-doc.yml @@ -0,0 +1,5 @@ +--- +title: Add Slack slash command api to services documentation and rearrange order and + cases +merge_request: 10757 +author: TM Lee diff --git a/doc/api/services.md b/doc/api/services.md index 7d4779f1137..0f42c256099 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -490,13 +490,78 @@ Remove all previously JIRA settings from a project. DELETE /projects/:id/services/jira ``` -## Mattermost Slash Commands +## Slack slash commands + +Ability to receive slash commands from a Slack chat instance. + +### Get Slack slash command service settings + +Get Slack slash command service settings for a project. + +``` +GET /projects/:id/services/slack-slash-commands +``` + +Example response: + +```json +{ + "id": 4, + "title": "Slack slash commands", + "created_at": "2017-06-27T05:51:39-07:00", + "updated_at": "2017-06-27T05:51:39-07:00", + "active": true, + "push_events": true, + "issues_events": true, + "merge_requests_events": true, + "tag_push_events": true, + "note_events": true, + "build_events": true, + "pipeline_events": true, + "properties": { + "token": "9koXpg98eAheJpvBs5tK" + } +} +``` + +### Create/Edit Slack slash command service + +Set Slack slash command for a project. + +``` +PUT /projects/:id/services/slack-slash-commands +``` + +Parameters: + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `token` | string | yes | The Slack token | + + +### Delete Slack slash command service + +Delete Slack slash command service for a project. + +``` +DELETE /projects/:id/services/slack-slash-commands +``` + +## Mattermost slash commands Ability to receive slash commands from a Mattermost chat instance. -### Create/Edit Mattermost Slash Command service +### Get Mattermost slash command service settings -Set Mattermost Slash Command for a project. +Get Mattermost slash command service settings for a project. + +``` +GET /projects/:id/services/mattermost-slash-commands +``` + +### Create/Edit Mattermost slash command service + +Set Mattermost slash command for a project. ``` PUT /projects/:id/services/mattermost-slash-commands @@ -509,22 +574,14 @@ Parameters: | `token` | string | yes | The Mattermost token | -### Delete Mattermost Slash Command service +### Delete Mattermost slash command service -Delete Mattermost Slash Command service for a project. +Delete Mattermost slash command service for a project. ``` DELETE /projects/:id/services/mattermost-slash-commands ``` -### Get Mattermost Slash Command service settings - -Get Mattermost Slash Command service settings for a project. - -``` -GET /projects/:id/services/mattermost-slash-commands -``` - ## Pipeline-Emails Get emails for GitLab CI pipelines.