diff --git a/content/developers/webhooks-and-events/events/github-event-types.md b/content/developers/webhooks-and-events/events/github-event-types.md index 93889de889..143e67c76d 100644 --- a/content/developers/webhooks-and-events/events/github-event-types.md +++ b/content/developers/webhooks-and-events/events/github-event-types.md @@ -94,7 +94,7 @@ Link: ; rel="next", {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for CommitCommentEvent {% data reusables.webhooks.commit_comment_properties %} @@ -104,7 +104,7 @@ Link: ; rel="next", {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for CreateEvent {% data reusables.webhooks.create_properties %} @@ -114,7 +114,7 @@ Link: ; rel="next", {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for DeleteEvent {% data reusables.webhooks.delete_properties %} @@ -124,7 +124,7 @@ Link: ; rel="next", {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for ForkEvent {% data reusables.webhooks.fork_properties %} @@ -134,7 +134,7 @@ Link: ; rel="next", {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for GollumEvent {% data reusables.webhooks.gollum_properties %} @@ -144,7 +144,7 @@ Link: ; rel="next", {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for IssueCommentEvent {% data reusables.webhooks.issue_comment_webhook_properties %} {% data reusables.webhooks.issue_comment_properties %} @@ -155,7 +155,7 @@ Link: ; rel="next", {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for IssuesEvent {% data reusables.webhooks.issue_event_api_properties %} {% data reusables.webhooks.issue_properties %} @@ -166,7 +166,7 @@ Link: ; rel="next", {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for MemberEvent {% data reusables.webhooks.member_event_api_properties %} {% data reusables.webhooks.member_properties %} @@ -175,7 +175,7 @@ Link: ; rel="next", ## PublicEvent {% data reusables.webhooks.public_short_desc %} -### Event `payload` object +### Event `payload` object for PublicEvent This event returns an empty `payload` object. {% endif %} @@ -185,7 +185,7 @@ This event returns an empty `payload` object. {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for PullRequestEvent {% data reusables.webhooks.pull_request_event_api_properties %} {% data reusables.webhooks.pull_request_properties %} @@ -196,7 +196,7 @@ This event returns an empty `payload` object. {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for PullRequestReviewEvent Key | Type | Description ----|------|------------- @@ -210,7 +210,7 @@ Key | Type | Description {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for PullRequestReviewCommentEvent {% data reusables.webhooks.pull_request_review_comment_event_api_properties %} {% data reusables.webhooks.pull_request_review_comment_properties %} @@ -221,7 +221,7 @@ Key | Type | Description {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for PullRequestReviewThreadEvent {% data reusables.webhooks.pull_request_thread_properties %} @@ -231,7 +231,7 @@ Key | Type | Description {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for PushEvent Key | Type | Description ----|------|------------- @@ -256,7 +256,7 @@ Key | Type | Description {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for ReleaseEvent {% data reusables.webhooks.release_event_api_properties %} {% data reusables.webhooks.release_properties %} @@ -266,7 +266,7 @@ Key | Type | Description {% data reusables.webhooks.sponsorship_short_desc %} -### Event `payload` object +### Event `payload` object for SponsorshipEvent {% data reusables.webhooks.sponsorship_event_api_properties %} {% data reusables.webhooks.sponsorship_properties %} @@ -278,6 +278,6 @@ Key | Type | Description {% data reusables.webhooks.events_api_payload %} -### Event `payload` object +### Event `payload` object for WatchEvent {% data reusables.webhooks.watch_properties %} diff --git a/content/rest/overview/media-types.md b/content/rest/overview/media-types.md index 8bdb3aff9c..d6eb3d162d 100644 --- a/content/rest/overview/media-types.md +++ b/content/rest/overview/media-types.md @@ -43,28 +43,28 @@ put it after `github`: The body of a comment can be written in [{% data variables.product.prodname_dotcom %} Flavored Markdown][gfm]. The APIs to manage [issues](/rest/reference/issues), [issue comments](/rest/reference/issues#comments), [pull request comments](/rest/reference/pulls#comments), and [gist comments](/rest/reference/gists#comments) all accept these same media types: -### Raw +### 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 +### 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 +### 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 +### Full media type for comment body properties application/vnd.github.full+json @@ -75,7 +75,7 @@ Return raw, text and HTML representations. Response will include `body`, The following media types are allowed when [getting a blob](/rest/reference/git#get-a-blob): -### JSON +### JSON media type for Git blob properties application/vnd.github+json application/json @@ -83,7 +83,7 @@ The following media types are allowed when [getting a blob](/rest/reference/git# Return JSON representation of the blob with `content` as a base64 encoded string. This is the default if nothing is passed. -### Raw +### Raw media type for Git blob properties application/vnd.github.raw @@ -93,27 +93,27 @@ Return the raw blob data. The REST API to manage [commits](/rest/reference/repos#commits) and [pull requests](/rest/reference/pulls) support [diff][git-diff] and [patch][git-patch] formats: -### diff +### diff media type for commits, commit comparison, and pull requests application/vnd.github.diff -### patch +### patch media type for commits, commit comparison, and pull requests application/vnd.github.patch -### sha +### sha media type for commits, commit comparison, and pull requests application/vnd.github.sha ## Repository contents -### Raw +### 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 +### HTML media type for repository contents application/vnd.github.html @@ -121,13 +121,13 @@ For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTM ## Gists -### Raw +### 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 +### base64 media type for gists application/vnd.github.base64