Added 'user/repos' missing endpoint #472
Conversation
Nyholm
left a comment
Nyholm
left a comment
There was a problem hiding this comment.
I like the idea but I'm not happy with the option parameter, especially since it's undocumented.
lib/Github/Api/User.php
Outdated
|
|
||
| /** | ||
| * @param null $username | ||
| * @param array $options |
There was a problem hiding this comment.
You should explain the valid array keys.
There was a problem hiding this comment.
or better add in-code assert
lib/Github/Api/User.php
Outdated
| */ | ||
| public function repos($username = null, array $options = array()) | ||
| { | ||
| $url = $username ? '/users/'.rawurldecode($username).'/repos' : '/user/repos'; |
There was a problem hiding this comment.
Hm. This seams like two functions mixed in one method. I'm not 100% convinced. It may be better to "repos()" and "myRepos()" (but with better naming)
There was a problem hiding this comment.
There is no other API endpoint that we are using an optional username. I recommend using two functions.
|
@Nyholm I don't agree with you about undocumented options since new options can be added as happened in this case, and the library has to be updated for each change. And also nearly all of the methods in the library can be considered as undocumented; see On the other hand, I think splitting |
Nyholm
left a comment
Nyholm
left a comment
There was a problem hiding this comment.
Okey, fair. Do not document it.
This is the last issue before (I think) we can tag a release candidate.
lib/Github/Api/User.php
Outdated
| } | ||
|
|
||
| /** | ||
| * @deprecated use repos($username, $options) instead |
There was a problem hiding this comment.
You should remove this function. It is okey, we will soon release a new major version.
Please make sure to add this in the changelog.
lib/Github/Api/User.php
Outdated
| */ | ||
| public function repos($username = null, array $options = array()) | ||
| { | ||
| $url = $username ? '/users/'.rawurldecode($username).'/repos' : '/user/repos'; |
There was a problem hiding this comment.
There is no other API endpoint that we are using an optional username. I recommend using two functions.
lib/Github/Api/User.php
Outdated
| * | ||
| * @return array list of the user repositories | ||
| */ | ||
| public function repos($username = null, array $options = array()) |
There was a problem hiding this comment.
you should use short array syntax []
|
@Nyholm @cursedcoder can you review it? |
3 participants
List repositories that are accessible to the authenticated user.
https://developer.github.com/v3/repos/#list-your-repositories
On the other hand, I think,
repositories($username, $type = 'owner', $sort = 'full_name', $direction = 'asc')method is outdated sinceaffiliationandvisibilityoptions are not covered