fix: update push payload descriptions (#691)

* build: cache * WIP: api.github.com webhooks update Co-authored-by: Octokit Bot <octokitbot@martynus.net>
octokit · Aug 10, 2022 · 5d5bb3c · 5d5bb3c
1 parent 3926e99
commit 5d5bb3c
Show file tree

Hide file tree

Showing 7 changed files with 101 additions and 21 deletions.
diff --git a/cache/api.github.com/webhook-events-and-payloads.html b/cache/api.github.com/webhook-events-and-payloads.html
@@ -15528,17 +15528,29 @@ <h3 id="webhook-payload-object-40">
           <tr>
             <td><code>commits[][added]</code></td>
             <td><code>array</code></td>
-            <td>An array of files added in the commit.</td>
+            <td>
+              An array of files added in the commit. For extremely large commits
+              where GitHub is unable to calculate this list in a timely manner,
+              this may be empty even if files were added.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][modified]</code></td>
             <td><code>array</code></td>
-            <td>An array of files modified by the commit.</td>
+            <td>
+              An array of files modified by the commit. For extremely large
+              commits where GitHub is unable to calculate this list in a timely
+              manner, this may be empty even if files were modified.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][removed]</code></td>
             <td><code>array</code></td>
-            <td>An array of files removed in the commit.</td>
+            <td>
+              An array of files removed in the commit. For extremely large
+              commits where GitHub is unable to calculate this list in a timely
+              manner, this may be empty even if files were removed.
+            </td>
           </tr>
           <tr>
             <td><code>pusher</code></td>

diff --git a/cache/ghes-32/webhook-events-and-payloads.html b/cache/ghes-32/webhook-events-and-payloads.html
@@ -14367,17 +14367,31 @@ <h3 id="webhook-payload-object-34">
           <tr>
             <td><code>commits[][added]</code></td>
             <td><code>array</code></td>
-            <td>An array of files added in the commit.</td>
+            <td>
+              An array of files added in the commit. For extremely large commits
+              where GitHub Enterprise Server is unable to calculate this list in
+              a timely manner, this may be empty even if files were added.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][modified]</code></td>
             <td><code>array</code></td>
-            <td>An array of files modified by the commit.</td>
+            <td>
+              An array of files modified by the commit. For extremely large
+              commits where GitHub Enterprise Server is unable to calculate this
+              list in a timely manner, this may be empty even if files were
+              modified.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][removed]</code></td>
             <td><code>array</code></td>
-            <td>An array of files removed in the commit.</td>
+            <td>
+              An array of files removed in the commit. For extremely large
+              commits where GitHub Enterprise Server is unable to calculate this
+              list in a timely manner, this may be empty even if files were
+              removed.
+            </td>
           </tr>
           <tr>
             <td><code>pusher</code></td>

diff --git a/cache/ghes-33/webhook-events-and-payloads.html b/cache/ghes-33/webhook-events-and-payloads.html
@@ -14376,17 +14376,31 @@ <h3 id="webhook-payload-object-34">
           <tr>
             <td><code>commits[][added]</code></td>
             <td><code>array</code></td>
-            <td>An array of files added in the commit.</td>
+            <td>
+              An array of files added in the commit. For extremely large commits
+              where GitHub Enterprise Server is unable to calculate this list in
+              a timely manner, this may be empty even if files were added.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][modified]</code></td>
             <td><code>array</code></td>
-            <td>An array of files modified by the commit.</td>
+            <td>
+              An array of files modified by the commit. For extremely large
+              commits where GitHub Enterprise Server is unable to calculate this
+              list in a timely manner, this may be empty even if files were
+              modified.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][removed]</code></td>
             <td><code>array</code></td>
-            <td>An array of files removed in the commit.</td>
+            <td>
+              An array of files removed in the commit. For extremely large
+              commits where GitHub Enterprise Server is unable to calculate this
+              list in a timely manner, this may be empty even if files were
+              removed.
+            </td>
           </tr>
           <tr>
             <td><code>pusher</code></td>

diff --git a/cache/ghes-34/webhook-events-and-payloads.html b/cache/ghes-34/webhook-events-and-payloads.html
@@ -14809,17 +14809,31 @@ <h3 id="webhook-payload-object-36">
           <tr>
             <td><code>commits[][added]</code></td>
             <td><code>array</code></td>
-            <td>An array of files added in the commit.</td>
+            <td>
+              An array of files added in the commit. For extremely large commits
+              where GitHub Enterprise Server is unable to calculate this list in
+              a timely manner, this may be empty even if files were added.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][modified]</code></td>
             <td><code>array</code></td>
-            <td>An array of files modified by the commit.</td>
+            <td>
+              An array of files modified by the commit. For extremely large
+              commits where GitHub Enterprise Server is unable to calculate this
+              list in a timely manner, this may be empty even if files were
+              modified.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][removed]</code></td>
             <td><code>array</code></td>
-            <td>An array of files removed in the commit.</td>
+            <td>
+              An array of files removed in the commit. For extremely large
+              commits where GitHub Enterprise Server is unable to calculate this
+              list in a timely manner, this may be empty even if files were
+              removed.
+            </td>
           </tr>
           <tr>
             <td><code>pusher</code></td>

diff --git a/cache/ghes-35/webhook-events-and-payloads.html b/cache/ghes-35/webhook-events-and-payloads.html
@@ -14822,17 +14822,31 @@ <h3 id="webhook-payload-object-36">
           <tr>
             <td><code>commits[][added]</code></td>
             <td><code>array</code></td>
-            <td>An array of files added in the commit.</td>
+            <td>
+              An array of files added in the commit. For extremely large commits
+              where GitHub Enterprise Server is unable to calculate this list in
+              a timely manner, this may be empty even if files were added.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][modified]</code></td>
             <td><code>array</code></td>
-            <td>An array of files modified by the commit.</td>
+            <td>
+              An array of files modified by the commit. For extremely large
+              commits where GitHub Enterprise Server is unable to calculate this
+              list in a timely manner, this may be empty even if files were
+              modified.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][removed]</code></td>
             <td><code>array</code></td>
-            <td>An array of files removed in the commit.</td>
+            <td>
+              An array of files removed in the commit. For extremely large
+              commits where GitHub Enterprise Server is unable to calculate this
+              list in a timely manner, this may be empty even if files were
+              removed.
+            </td>
           </tr>
           <tr>
             <td><code>pusher</code></td>

diff --git a/cache/github.ae/webhook-events-and-payloads.html b/cache/github.ae/webhook-events-and-payloads.html
@@ -13439,17 +13439,29 @@ <h3 id="webhook-payload-object-32">
           <tr>
             <td><code>commits[][added]</code></td>
             <td><code>array</code></td>
-            <td>An array of files added in the commit.</td>
+            <td>
+              An array of files added in the commit. For extremely large commits
+              where GitHub AE is unable to calculate this list in a timely
+              manner, this may be empty even if files were added.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][modified]</code></td>
             <td><code>array</code></td>
-            <td>An array of files modified by the commit.</td>
+            <td>
+              An array of files modified by the commit. For extremely large
+              commits where GitHub AE is unable to calculate this list in a
+              timely manner, this may be empty even if files were modified.
+            </td>
           </tr>
           <tr>
             <td><code>commits[][removed]</code></td>
             <td><code>array</code></td>
-            <td>An array of files removed in the commit.</td>
+            <td>
+              An array of files removed in the commit. For extremely large
+              commits where GitHub AE is unable to calculate this list in a
+              timely manner, this may be empty even if files were removed.
+            </td>
           </tr>
           <tr>
             <td><code>pusher</code></td>

diff --git a/payload-examples/api.github.com/index.json b/payload-examples/api.github.com/index.json
@@ -58558,15 +58558,15 @@
       },
       "commits[][added]": {
         "type": "array",
-        "description": "An array of files added in the commit."
+        "description": "An array of files added in the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were added."
       },
       "commits[][modified]": {
         "type": "array",
-        "description": "An array of files modified by the commit."
+        "description": "An array of files modified by the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were modified."
       },
       "commits[][removed]": {
         "type": "array",
-        "description": "An array of files removed in the commit."
+        "description": "An array of files removed in the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were removed."
       },
       "pusher": {
         "type": "object",