{ "opencollection": "1.0.0", "info": { "name": "github-repos-api Directories API", "version": "1.1.4" }, "items": [ { "info": { "name": "Directories", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get Repository Readme for Directory", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/repos/:owner/:repo/readme/:dir", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "dir", "value": "example_value", "type": "path", "description": "The alternate path to look for a README file" }, { "name": "ref", "value": "main", "type": "query", "description": "The name of the commit/branch/tag. Default: the repositorys default branch." } ] }, "docs": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML " } ] } ], "bundled": true }