Commit1763119

committed

Document the media type param for directories

Seegithub/github#41240 for more details.

1 parent1815ff8 commit1763119Copy full SHA for 1763119

File tree

-1

lines changed

-1

lines changed

Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,8 @@ This method returns the contents of a file or directory in a repository.`
`36`	`36`	`GET /repos/:owner/:repo/contents/:path`
`37`	`37`
`38`	`38`	`Files and symlinks support[a custom media type](#custom-media-types) for retrieving the raw content or rendered HTML (when supported).`
`39`		`-Directories and submodules do_not_ support custom media types.`
	`39`	`+Directories support[a custom media type](#custom-media-types) for retrieving the content as an object rather than an array of its entries.`
	`40`	`+Submodules do_not_ support custom media types.`
`40`	`41`
`41`	`42`	`{{#tip}}`
`42`	`43`
`@@ -282,6 +283,12 @@ curl -L https://api.github.com/repos/octokit/octokit.rb/tarball > octokit.tar.gz`
`282`	`283`
`283`	`284`	Use the`.raw` media type to retrieve the contents of the file.
`284`	`285`
	`286`	`+[Directories](#get-contents) support the following custom media type:`
	`287`	`+`
	`288`	`+application/vnd.github.VERSION.object`
	`289`	`+`
	`290`	+Use the`.object` media type to retrieve the directory contents as an object rather than an array of its entries.
	`291`	`+`
`285`	`292`	For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the`.html` media type. Markup languages are rendered to HTML using our open-source[Markup library](https://github.com/github/markup).
`286`	`293`
`287`	`294`	`You can read more about the use of media types in the API[here](/v3/media/).`

Comments

(0)