Remove Media Types info from REST stub files (#48566)
This commit is contained in:
Jess Hosman
@@ -13,6 +13,9 @@ redirect_from:
|
||||
- /rest/initialize-the-repo
|
||||
- /rest/overview/resources-in-the-rest-api
|
||||
- /rest/using-the-rest-api/resources-in-the-rest-api
|
||||
- /v3/media
|
||||
- /rest/overview/media-types
|
||||
- /rest/using-the-rest-api/media-types
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
@@ -13,7 +13,6 @@ children:
|
||||
- /rate-limits-for-the-rest-api
|
||||
- /using-pagination-in-the-rest-api
|
||||
- /libraries-for-the-rest-api
|
||||
- /media-types
|
||||
- /best-practices-for-using-the-rest-api
|
||||
- /troubleshooting-the-rest-api
|
||||
- /timezones-and-the-rest-api
|
||||
@@ -21,4 +20,3 @@ children:
|
||||
- /issue-event-types
|
||||
- /github-event-types
|
||||
---
|
||||
|
||||
|
||||
@@ -1,135 +0,0 @@
|
||||
---
|
||||
title: Media types
|
||||
intro: Learn about media types for specifying the format of the data you want to consume.
|
||||
redirect_from:
|
||||
- /v3/media
|
||||
- /rest/overview/media-types
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- API
|
||||
---
|
||||
|
||||
|
||||
Custom media types are used in the API to let consumers choose the format
|
||||
of the data they wish to receive. This is done by adding one or more of
|
||||
the following types to the `Accept` header when you make a request. Media types
|
||||
are specific to resources, allowing them to change independently and support
|
||||
formats that other resources don't.
|
||||
|
||||
All {% data variables.product.product_name %} media types look like this:
|
||||
|
||||
application/vnd.github.param[+json]
|
||||
|
||||
The most basic media types the API supports are:
|
||||
|
||||
application/vnd.github+json
|
||||
application/json
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** In the past, we recommended including `v3` in your `Accept` header. This is no longer required and will have no impact on your API requests.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
If you're specifying a property (such as full/raw/etc defined below),
|
||||
put it after `github`:
|
||||
|
||||
application/vnd.github.raw+json
|
||||
|
||||
## Comment body properties
|
||||
|
||||
The body of a comment can be written in [{% data variables.product.prodname_dotcom %} Flavored Markdown](https://github.github.com/github-flavored-markdown/). The APIs to manage [issues](/rest/issues), [issue comments](/rest/issues#comments), [pull request comments](/rest/pulls#comments), and [gist comments](/rest/gists#comments) all accept these same media types:
|
||||
|
||||
### Raw media type for comment body properties
|
||||
|
||||
application/vnd.github.raw+json
|
||||
|
||||
Return the raw markdown body. Response will include `body`. This is the
|
||||
default if you do not pass any specific media type.
|
||||
|
||||
### Text media type for comment body properties
|
||||
|
||||
application/vnd.github.text+json
|
||||
|
||||
Return a text only representation of the markdown body. Response will
|
||||
include `body_text`.
|
||||
|
||||
### HTML media type for comment body properties
|
||||
|
||||
application/vnd.github.html+json
|
||||
|
||||
Return HTML rendered from the body's markdown. Response will include
|
||||
`body_html`.
|
||||
|
||||
### Full media type for comment body properties
|
||||
|
||||
application/vnd.github.full+json
|
||||
|
||||
Return raw, text and HTML representations. Response will include `body`,
|
||||
`body_text`, and `body_html`:
|
||||
|
||||
## Git blob properties
|
||||
|
||||
The following media types are allowed when [getting a blob](/rest/git#get-a-blob):
|
||||
|
||||
### JSON media type for Git blob properties
|
||||
|
||||
application/vnd.github+json
|
||||
application/json
|
||||
|
||||
Return JSON representation of the blob with `content` as a base64
|
||||
encoded string. This is the default if nothing is passed.
|
||||
|
||||
### Raw media type for Git blob properties
|
||||
|
||||
application/vnd.github.raw
|
||||
|
||||
Return the raw blob data.
|
||||
|
||||
## Commits, commit comparison, and pull requests
|
||||
|
||||
The REST API to manage [commits](/rest/repos#commits) and [pull requests](/rest/pulls) support [diff](https://git-scm.com/docs/git-diff) and [patch](https://git-scm.com/docs/git-format-patch) formats:
|
||||
|
||||
### diff media type for commits, commit comparison, and pull requests
|
||||
|
||||
application/vnd.github.diff
|
||||
|
||||
### patch media type for commits, commit comparison, and pull requests
|
||||
|
||||
application/vnd.github.patch
|
||||
|
||||
### sha media type for commits, commit comparison, and pull requests
|
||||
|
||||
application/vnd.github.sha
|
||||
|
||||
## Repository contents
|
||||
|
||||
### Raw media type for repository contents
|
||||
|
||||
application/vnd.github.raw
|
||||
|
||||
Return the raw contents of a file. This is the default if you do not pass any specific media type.
|
||||
|
||||
### HTML media type for repository contents
|
||||
|
||||
application/vnd.github.html
|
||||
|
||||
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).
|
||||
|
||||
## Gists
|
||||
|
||||
### Raw media type for gists
|
||||
|
||||
application/vnd.github.raw
|
||||
|
||||
Return the raw contents of a gist. This is the default if you do not pass any specific media type.
|
||||
|
||||
### base64 media type for gists
|
||||
|
||||
application/vnd.github.base64
|
||||
|
||||
The gist contents are base64-encoded before being sent out. This can be useful if your gist contains any invalid UTF-8 sequences.
|
||||
Reference in New Issue
Block a user