Upcoming Changes to Events API Doc Changes (#57244)

Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com>

Author: jessmargz

content/rest/using-the-rest-api/github-event-types.md

@@ -63,31 +63,33 @@ Link: <https://api.github.com/resource?page=2>; rel="next",
 ```json
 [
   {
+    "id": "12345",
     "type": "WatchEvent",
-    "public": false,
-    "payload": {
+    "actor": {
+      "id": 1,
+      "login": "octocat",
+      "display_login": "octocat",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/octocat",
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif"
     },
     "repo": {
       "id": 3,
       "name": "octocat/Hello-World",
       "url": "https://api.github.com/repos/octocat/Hello-World"
     },
-    "actor": {
-      "id": 1,
-      "login": "octocat",
-      "gravatar_id": "",
-      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-      "url": "https://api.github.com/users/octocat"
+    "payload": {
+      "action": "started"
     },
+    "public": false,
+    "created_at": "2011-09-06T17:26:27Z",
     "org": {
       "id": 1,
       "login": "github",
       "gravatar_id": "",
       "url": "https://api.github.com/orgs/github",
       "avatar_url": "https://github.com/images/error/octocat_happy.gif"
     },
-    "created_at": "2011-09-06T17:26:27Z",
-    "id": "12345"
   }
 ]
 ```
@@ -122,6 +124,20 @@ Link: <https://api.github.com/resource?page=2>; rel="next",
 
 {% data reusables.webhooks.delete_properties %}
 
+{% ifversion fpt or ghec %}
+
+## DiscussionEvent
+
+{% data reusables.webhooks.discussion_short_desc %}
+
+{% data reusables.webhooks.events_api_payload %}
+
+### Event `payload` object for DiscussionEvent
+
+{% data reusables.webhooks.discussion_properties %}
+
+{% endif %}
+
 ## ForkEvent
 
 {% data reusables.webhooks.fork_short_desc %}
@@ -202,11 +218,7 @@ This event returns an empty `payload` object.
 
 ### Event `payload` object for PullRequestReviewEvent
 
-Key | Type | Description
-----|------|-------------
-`action` | `string` | The action that was performed. Can be `created`.
-`pull_request` | `object` | The pull request the review pertains to.
-`review` | `object` |	The review that was affected.
+{% data reusables.webhooks.pull_request_review_properties %}
 
 ## PullRequestReviewCommentEvent
 
@@ -219,16 +231,6 @@ Key | Type | Description
 {% data reusables.webhooks.pull_request_review_comment_event_api_properties %}
 {% data reusables.webhooks.pull_request_review_comment_properties %}
 
-## PullRequestReviewThreadEvent
-
-{% data reusables.webhooks.pull_request_review_thread_short_desc %}
-
-{% data reusables.webhooks.events_api_payload %}
-
-### Event `payload` object for PullRequestReviewThreadEvent
-
-{% data reusables.webhooks.pull_request_thread_properties %}
-
 ## PushEvent
 
 {% data reusables.webhooks.push_short_desc %}
@@ -237,22 +239,7 @@ Key | Type | Description
 
 ### Event `payload` object for PushEvent
 
-Key | Type | Description
-----|------|-------------
-`push_id` | `integer` | Unique identifier for the push.
-`size`|`integer` | The number of commits in the push.
-`distinct_size`|`integer` | The number of distinct commits in the push.
-`ref`|`string` | The full [`git ref`](/rest/git/refs) that was pushed. Example: `refs/heads/main`.
-`head`|`string` | The SHA of the most recent commit on `ref` after the push.
-`before`|`string` | The SHA of the most recent commit on `ref` before the push.
-`commits`|`array` | An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](/rest/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)
-`commits[][sha]`|`string` | The SHA of the commit.
-`commits[][message]`|`string` | The commit message.
-`commits[][author]`|`object` | The git author of the commit.
-`commits[][author][name]`|`string` | The git author's name.
-`commits[][author][email]`|`string` | The git author's email address.
-`commits[][url]`|`url` | URL that points to the commit API resource.
-`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before.
+{% data reusables.webhooks.push_properties %}
 
 ## ReleaseEvent
 
@@ -265,18 +252,6 @@ Key | Type | Description
 {% data reusables.webhooks.release_event_api_properties %}
 {% data reusables.webhooks.release_properties %}
 
-{% ifversion fpt or ghec %}
-
-## SponsorshipEvent
-
-{% data reusables.webhooks.sponsorship_short_desc %}
-
-### Event `payload` object for SponsorshipEvent
-
-{% data reusables.webhooks.sponsorship_event_api_properties %}
-{% data reusables.webhooks.sponsorship_properties %}
-{% endif %}
-
 ## WatchEvent
 
 {% data reusables.webhooks.watch_short_desc %}

data/reusables/webhooks/commit_comment_properties.md

@@ -1,4 +1,6 @@
 Key | Type | Description
 ----|------|-------------
+| {% ifversion fpt or ghec %} |
 `action`|`string` | The action performed. Can be `created`.
+| {% endif %} |
 `comment`|`object` | The [commit comment](/rest/commits#get-a-commit-comment) resource.

data/reusables/webhooks/create_properties.md

@@ -1,7 +1,10 @@
 Key | Type | Description
 ----|------|-------------
-`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource, or `null` if `ref_type` is `repository`.
+`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource branch, or `null` if `ref_type` is `repository`.
 `ref_type`|`string` | The type of Git ref object created in the repository. Can be either `branch`, `tag`, or `repository`.
+| {% ifversion fpt or ghec %} |
+`full_ref`|`string` | The fully-formed ref resource, meaning that for branches the format is `refs/heads/<branch_name>`.
+| {% endif %} |
 `master_branch`|`string` | The name of the repository's default branch (usually `main`).
 `description`|`string` | The repository's current description.
 `pusher_type`|`string` | Can be either `user` or a deploy key.

data/reusables/webhooks/delete_properties.md

@@ -1,4 +1,8 @@
 Key | Type | Description
 ----|------|-------------
-`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource.
+`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource branch.
 `ref_type`|`string` | The type of Git ref object deleted in the repository. Can be either `branch` or `tag`.
+| {% ifversion fpt or ghec %} |
+`full_ref`|`string` | The fully-formed ref resource, meaning that for branches the format is `refs/heads/<branch_name>`.
+| {% endif %} |
+`pusher_type`|`string` | Can be either `user` or a deploy key.

data/reusables/webhooks/discussion_properties.md

@@ -0,0 +1,4 @@
+Key | Type | Description
+----|------|-------------
+`action`|`string`| The action performed. Can be `created`.
+`discussion`|`object`| The discussion that was created.

data/reusables/webhooks/discussion_short_desc.md

@@ -0,0 +1 @@
+A discussion is created in a repository. For more information, see [AUTOTITLE](/discussions).

data/reusables/webhooks/fork_properties.md

@@ -1,3 +1,6 @@
 Key | Type | Description
 ----|------|-------------
+| {% ifversion fpt or ghec %} |
+`action`|`string` | The action performed. Can be `forked`.
+| {% endif %} |
 `forkee`|`object` | The created [`repository`](/rest/repos#get-a-repository) resource.

data/reusables/webhooks/gollum_properties.md

@@ -3,6 +3,7 @@ Key | Type | Description
 `pages`|`array` | The pages that were updated.
 `pages[][page_name]`|`string` | The name of the page.
 `pages[][title]`|`string` | The current page title.
+`pages[][summary]`|`string` | An optional note about the page. Can be `null`.
 `pages[][action]`|`string` | The action that was performed on the page. Can be `created` or `edited`.
 `pages[][sha]`|`string` | The latest commit SHA of the page.
 `pages[][html_url]`|`string` | Points to the HTML wiki page.

data/reusables/webhooks/issue_comment_properties.md

@@ -1,4 +1,2 @@
-`changes`|`object` | The changes to the comment if the action was `edited`.
-`changes[body][from]` |`string` | The previous version of the body if the action was `edited`.
 `issue`|`object` | The [issue](/rest/issues) the comment belongs to.
 `comment`|`object` | The [comment](/rest/issues#comments) itself.

data/reusables/webhooks/issue_comment_webhook_properties.md

@@ -1,3 +1,3 @@
 Key | Type | Description
 ----|------|-------------
-`action`|`string` | The action that was performed on the comment. Can be one of `created`, `edited`, or `deleted`.
+`action`|`string` | The action that was performed on the comment. Can be `created`.