v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB

repos

Get a repository README for a directory

Gets the README from a repository directory.

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

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

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.

dirstring required

The alternate path to look for a README file

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\""
}