pub async fn repos_slash_get_content(
configuration: &Configuration,
owner: &str,
repo: &str,
path: &str,
ref: Option<&str>,
) -> Result<ContentTree, Error<ReposSlashGetContentError>>
Expand description
Gets the contents of a file or directory in a repository. Specify the file path or directory with the path
parameter. If you omit the path
parameter, you will receive the contents of the repository’s root directory. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json
: Returns the raw file contents for files and symlinks. - application/vnd.github.html+json
: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub’s open-source Markup library. - application/vnd.github.object+json
: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries
attribute containing the array of objects. If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value should be "submodule". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as "submodule". If the content is a symlink and the symlink’s target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. If the content is a submodule, the submodule_git_url
field identifies the location of the submodule repository, and the sha
identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url
and _links[\"git\"]
) and the github.com URLs (html_url
and _links[\"html\"]
) will have null values. Notes: - To get a repository’s contents recursively, you can recursively get the tree. - This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees API. - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - If the requested file’s size is: - 1 MB or smaller: All features of this endpoint are supported. - Between 1-100 MB: Only the raw
or object
custom media types are supported. Both will work as normal, except that when using the object
media type, the content
field will be an empty string and the encoding
field will be \"none\"
. To get the contents of these larger files, use the raw
media type. - Greater than 100 MB: This endpoint is not supported.