Skip to content

Commit 3622ddc

Browse files
committed
Add milestones doc, closes #142
1 parent b02245b commit 3622ddc

File tree

3 files changed

+47
-6
lines changed

3 files changed

+47
-6
lines changed

doc/issue/milestones.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Issues / Milestones API
2+
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)
3+
4+
Wraps [GitHub Issue Milestones API](http://developer.github.com/v3/issues/milestones/).
5+
6+
### List project milestones
7+
8+
```php
9+
$milestones = $client->api('issue')->milestones()->all('KnpLabs', 'php-github-api');
10+
```
11+
12+
### Get information about milestone
13+
14+
```php
15+
$milestone = $client->api('issue')->milestones()->show('KnpLabs', 'php-github-api', 123);
16+
```
17+
18+
### Create a new milestone
19+
20+
```php
21+
$milestone = $client->api('issue')->milestones()->create('KnpLabs', 'php-github-api', array('title' => '3.0'));
22+
```
23+
24+
### Update a milestone
25+
26+
```php
27+
$milestone = $client->api('issue')->milestones()->update('KnpLabs', 'php-github-api', 123);
28+
```
29+
30+
### Remove a milestonre
31+
32+
```php
33+
$client->api('issue')->milestones()->remove('KnpLabs', 'php-github-api', 123);
34+
```
35+
36+
### List milestone labels
37+
38+
```php
39+
$labels = $client->api('issue')->milestones()->labels('KnpLabs', 'php-github-api', 123);
40+
```

doc/issues.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Wraps [GitHub Issue API](http://developer.github.com/v3/issues/).
77
Additional APIs:
88
* [Comments](issue/comments.md)
99
* [Labels](issue/labels.md)
10+
* [Milestones](issue/milestones.md)
1011

1112
### List issues in a project
1213

lib/Github/Api/Issue/Milestones.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,22 +43,22 @@ public function create($username, $repository, array $params)
4343
return $this->post('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones', $params);
4444
}
4545

46-
public function update($username, $repository, $milestone, array $params)
46+
public function update($username, $repository, $id, array $params)
4747
{
4848
if (isset($params['state']) && !in_array($params['state'], array('open', 'closed'))) {
4949
$params['state'] = 'open';
5050
}
5151

52-
return $this->patch('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.rawurlencode($milestone), $params);
52+
return $this->patch('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.rawurlencode($id), $params);
5353
}
5454

55-
public function remove($username, $repository, $milestone)
55+
public function remove($username, $repository, $id)
5656
{
57-
return $this->delete('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.rawurlencode($milestone));
57+
return $this->delete('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.rawurlencode($id));
5858
}
5959

60-
public function labels($username, $repository, $milestone)
60+
public function labels($username, $repository, $id)
6161
{
62-
return $this->get('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.rawurlencode($milestone).'/labels');
62+
return $this->get('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.rawurlencode($id).'/labels');
6363
}
6464
}

0 commit comments

Comments
 (0)