Github API - Test Config

Flexydox
GET /repos/{owner}/{repo}/readme
repos

Gets the preferred README for a repository.

READMEs support custom media types for retrieving the raw content or rendered HTML.
Get a repository README

Arguments
key owner

owner [scalar]

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

API:
Github Open API
(version: 1.1.4)

https://api.github.com

key repo

repo [scalar]

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

API:
Github Open API
(version: 1.1.4)

https://api.github.com

ref string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Returns
200 application/json content-file

content-file [object]

Content File

Attributes
_links 1956

content string

download_url string

encoding string

git_url string

html_url string

name string

path string

sha string

size integer

submodule_git_url string

target string

type string

url string

API:
Github Open API
(version: 1.1.4)

https://api.github.com
404 not_found

not_found [scalar]

Resource not found

API:
Github Open API
(version: 1.1.4)

https://api.github.com
422 validation_failed

validation_failed [scalar]

Validation failed, or the endpoint has been spammed.

API:
Github Open API
(version: 1.1.4)

https://api.github.com
API:
Github Open API
(version: 1.1.4)

https://api.github.com