summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTomasz Maczukin <tomasz@maczukin.pl>2016-01-13 20:46:34 +0100
committerTomasz Maczukin <tomasz@maczukin.pl>2016-01-14 10:57:56 +0100
commit633ac13404a38bfa3901f515179dc795cded2fa9 (patch)
treebd8036ae49658c240ca8d58438210498851d0973
parentd44653da1f74c2c15fe7ec3f8aa9b16563ffebd6 (diff)
downloadgitlab-ce-633ac13404a38bfa3901f515179dc795cded2fa9.tar.gz
Modify triggers API documentation style [ci skip]
-rw-r--r--doc/api/README.md2
-rw-r--r--doc/api/build_triggers.md128
-rw-r--r--doc/api/triggers.md90
3 files changed, 129 insertions, 91 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index 1838bcc0bb9..4dc5c931f52 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -23,7 +23,7 @@
- [Namespaces](namespaces.md)
- [Settings](settings.md)
- [Keys](keys.md)
-- [Triggers](triggers.md)
+- [Build triggers](build_triggers.md)
## Clients
diff --git a/doc/api/build_triggers.md b/doc/api/build_triggers.md
new file mode 100644
index 00000000000..14f7e3534bd
--- /dev/null
+++ b/doc/api/build_triggers.md
@@ -0,0 +1,128 @@
+# Build triggers
+
+## List project triggers
+
+Get a list of project triggers
+
+```
+GET /projects/:id/triggers
+```
+
+### Parameters
+
+| Attribute | Type | required | Description |
+|-----------|---------|----------|---------------------|
+| id | integer | yes | The ID of a project |
+
+### Example of request
+
+```
+curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers"
+```
+
+### Example of response
+
+```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 trigger of a project
+
+```
+GET /projects/:id/triggers/:token
+```
+
+### Parameters
+
+| Attribute | Type | required | Description |
+|-----------|---------|----------|--------------------------|
+| id | integer | yes | The ID of a project |
+| token | string | yes | The `token` of a project |
+
+### Example of request
+
+```
+curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"
+```
+
+### Example of response
+
+```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 trigger for a project
+
+```
+POST /projects/:id/triggers
+```
+
+### Parameters
+
+| Attribute | Type | required | Description |
+|-----------|---------|----------|--------------------------|
+| id | integer | yes | The ID of a project |
+
+### Example of request
+
+```
+curl -X POST -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers"
+```
+
+### Example of response
+
+```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 trigger of a project
+
+```
+DELETE /projects/:id/triggers/:token
+```
+
+### Parameters
+
+| Attribute | Type | required | Description |
+|-----------|---------|----------|--------------------------|
+| id | integer | yes | The ID of a project |
+| token | string | yes | The `token` of a project |
+
+### Example of request
+
+```
+curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"
+```
diff --git a/doc/api/triggers.md b/doc/api/triggers.md
deleted file mode 100644
index 4150d7b4c10..00000000000
--- a/doc/api/triggers.md
+++ /dev/null
@@ -1,90 +0,0 @@
-# Triggers
-
-## List project triggers
-
-Get a list of project triggers
-
-```
-GET /projects/:id/triggers
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-
-```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 trigger of a project
-
-```
-GET /projects/:id/triggers/:token
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-- `token` (required) - The `token` of a trigger
-
-```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 trigger for a project
-
-```
-POST /projects/:id/triggers
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-
-```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 trigger of a project
-
-```
-DELETE /projects/:id/triggers/:token
-```
-
-Parameters:
-
-- `id` (required) - The ID of a project
-- `token` (required) - The `token` of a trigger