From 57fd233a557158dbaa1a227f7c549fbe6a45e799 Mon Sep 17 00:00:00 2001 From: Zeger-Jan van de Weg Date: Wed, 19 Oct 2016 14:08:30 +0000 Subject: Update docs and unexpose token --- doc/api/system_hooks.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) (limited to 'doc/api') diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md index 073e99b7147..569831af540 100644 --- a/doc/api/system_hooks.md +++ b/doc/api/system_hooks.md @@ -27,11 +27,14 @@ Example response: ```json [ - { - "id" : 1, - "url" : "https://gitlab.example.com/hook", - "created_at" : "2015-11-04T20:07:35.874Z" - } + { + "id":1, + "url":"https://gitlab.example.com/hook", + "created_at":"2016-10-31T12:32:15.192Z", + "push_events":true, + "tag_push_events":false, + "enable_ssl_verification":true + } ] ``` @@ -48,6 +51,10 @@ POST /hooks | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `url` | string | yes | The hook URL | +| token | string | no | The token to validate payloads | +| push_events | boolean | no | When true, the hook will fire on push events | +| tag_push_events | boolean | no | When true, the hook will fire on new tags being pushed | +| enable_ssl_verification | boolean | no | Do SSL verification when triggering the hook | Example request: @@ -59,11 +66,14 @@ Example response: ```json [ - { - "id" : 2, - "url" : "https://gitlab.example.com/hook", - "created_at" : "2015-11-04T20:07:35.874Z" - } + { + "id":1, + "url":"https://gitlab.example.com/hook", + "created_at":"2016-10-31T12:32:15.192Z", + "push_events":true, + "tag_push_events":false, + "enable_ssl_verification":true + } ] ``` -- cgit v1.2.1 From 37f229c7358a48c6a9af3481927e9e4faee17e3d Mon Sep 17 00:00:00 2001 From: "Z.J. van de Weg" Date: Wed, 2 Nov 2016 13:24:24 +0100 Subject: Update docs and test description [ci skip] --- doc/api/system_hooks.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/api') diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md index 569831af540..efd23d514bc 100644 --- a/doc/api/system_hooks.md +++ b/doc/api/system_hooks.md @@ -51,10 +51,10 @@ POST /hooks | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `url` | string | yes | The hook URL | -| token | string | no | The token to validate payloads | -| push_events | boolean | no | When true, the hook will fire on push events | -| tag_push_events | boolean | no | When true, the hook will fire on new tags being pushed | -| enable_ssl_verification | boolean | no | Do SSL verification when triggering the hook | +| `token` | string | no | Secret token to validate received payloads; this will not be returned in the response | +| `push_events` | boolean | no | When true, the hook will fire on push events | +| `tag_push_events` | boolean | no | When true, the hook will fire on new tags being pushed | +| `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook | Example request: -- cgit v1.2.1