diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2016-04-06 20:53:17 +0200 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2016-04-06 20:53:17 +0200 |
| commit | e6215a9a8ed20354782120a7ce6368c7e8aab9a5 (patch) | |
| tree | 44d1c73605a5ffb05c0b831e861ca1ce15fbdfa2 /doc/api/milestones.md | |
| parent | 0728588c3424fd7e75ca3c45ad1ea84063437311 (diff) | |
| download | gitlab-ce-e6215a9a8ed20354782120a7ce6368c7e8aab9a5.tar.gz | |
Improve coding and doc style
Diffstat (limited to 'doc/api/milestones.md')
| -rw-r--r-- | doc/api/milestones.md | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/api/milestones.md b/doc/api/milestones.md index 4d94d7f3e2c..e4202025f80 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -11,6 +11,20 @@ GET /projects/:id/milestones?state=active GET /projects/:id/milestones?state=closed ``` +Parameters: + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `id` | integer | yes | The ID of a project | +| `iid` | integer | optional | Return only the milestone having the given `iid` | +| `state` | string | optional | Return only `active` or `closed` milestones` | + +```bash +curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/milestones +``` + +Example Response: + ```json [ { @@ -27,11 +41,6 @@ GET /projects/:id/milestones?state=closed ] ``` -Parameters: - -- `id` (required) - The ID of a project -- `iid` (optional) - Return the milestone having the given `iid` -- `state` (optional) - Return "active" or "closed" milestones ## Get single milestone |