Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kazuhiko Shiozaki
gitlab-ce
Commits
633ac134
Commit
633ac134
authored
Jan 13, 2016
by
Tomasz Maczukin
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Modify triggers API documentation style [ci skip]
parent
d44653da
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
129 additions
and
1 deletion
+129
-1
doc/api/README.md
doc/api/README.md
+1
-1
doc/api/build_triggers.md
doc/api/build_triggers.md
+128
-0
No files found.
doc/api/README.md
View file @
633ac134
...
@@ -23,7 +23,7 @@
...
@@ -23,7 +23,7 @@
-
[
Namespaces
](
namespaces.md
)
-
[
Namespaces
](
namespaces.md
)
-
[
Settings
](
settings.md
)
-
[
Settings
](
settings.md
)
-
[
Keys
](
keys.md
)
-
[
Keys
](
keys.md
)
-
[
Triggers
](
triggers.md
)
-
[
Build triggers
](
build_
triggers.md
)
## Clients
## Clients
...
...
doc/api/triggers.md
→
doc/api/
build_
triggers.md
View file @
633ac134
#
T
riggers
#
Build t
riggers
## List project triggers
## List project triggers
...
@@ -8,9 +8,19 @@ Get a list of project triggers
...
@@ -8,9 +8,19 @@ Get a list of project triggers
GET /projects/:id/triggers
GET /projects/:id/triggers
```
```
Parameters:
### Parameters
-
`id`
(required) - The ID of a project
| 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
```
json
[
[
...
@@ -39,10 +49,20 @@ Get details of trigger of a project
...
@@ -39,10 +49,20 @@ Get details of trigger of a project
GET /projects/:id/triggers/:token
GET /projects/:id/triggers/:token
```
```
Parameters:
### 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"
```
-
`id`
(required) - The ID of a project
### Example of response
-
`token`
(required) - The
`token`
of a trigger
```
json
```
json
{
{
...
@@ -62,9 +82,19 @@ Create a trigger for a project
...
@@ -62,9 +82,19 @@ Create a trigger for a project
POST /projects/:id/triggers
POST /projects/:id/triggers
```
```
Parameters:
### Parameters
-
`id`
(required) - The ID of a project
| 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
```
json
{
{
...
@@ -84,7 +114,15 @@ Remove a trigger of a project
...
@@ -84,7 +114,15 @@ Remove a trigger of a project
DELETE /projects/:id/triggers/:token
DELETE /projects/:id/triggers/:token
```
```
Parameters:
### Parameters
-
`id`
(required) - The ID of a project
| Attribute | Type | required | Description |
-
`token`
(required) - The
`token`
of a trigger
|-----------|---------|----------|--------------------------|
| 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"
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment