Skip to content

Added dir parameter for Repo readme #1032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2021
Merged

Added dir parameter for Repo readme #1032

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions lib/Github/Api/Repo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,13 +257,20 @@ public function remove($username, $repository)
* @param string $username the user who owns the repository
* @param string $repository the name of the repository
* @param string $format one of formats: "raw", "html", or "v3+json"
* @param string $dir The alternate path to look for a README file
* @param array $params additional query params like "ref" to fetch readme for branch/tag
*
* @return string|array the readme content
*/
public function readme($username, $repository, $format = 'raw', $params = [])
public function readme($username, $repository, $format = 'raw', $dir = null, $params = [])
{
return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/readme', $params, [
$path = '/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/readme';

if (null !== $dir) {
$path .= '/'.rawurlencode($dir);
}

return $this->get($path, $params, [
'Accept' => "application/vnd.github.$format",
]);
}
Expand Down