v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-01-0382859610.0 MB

repos

Get a repository README

Gets the preferred README for a repository.

READMEs support custom media types for retrieving the raw content or rendered HTML.

get/repos/{owner}/{repo}/readme

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

refstring

The name of the commit/branch/tag. Default: the repository’s default branch.

type'file' required

encodingstring required

sizeinteger required

namestring required

pathstring required

contentstring required

shastring required

urlstring uri required

git_urlstring uri nullable required

html_urlstring uri nullable required

download_urlstring uri nullable required

targetstring

submodule_git_urlstring

{
  "target": "\"actual/actual.md\"",
  "submodule_git_url": "\"git://example.com/defunkt/dotjs.git\""
}