fix: description updates for the check_suite event (#672)

octokitbot · Octokit Bot · wolfy1339 · web-flow · commit 2006fc31bac9 · 2022-07-14T14:34:00.000-04:00
Co-authored-by: Octokit Bot &lt;octokitbot@martynus.net&gt;
Co-authored-by: wolfy1339 &lt;webmaster@wolfy1339.com&gt;
diff --git a/cache/api.github.com/webhook-events-and-payloads.html b/cache/api.github.com/webhook-events-and-payloads.html
@@ -1954,8 +1954,8 @@ <h3 id="webhook-payload-object-2">
             <td><code>string</code></td>
             <td>
               The summary status for all check runs that are part of the check
-              suite. Can be <code>requested</code>, <code>in_progress</code>, or
-              <code>completed</code>.
+              suite. Can be <code>queued</code>, <code>requested</code>,
+              <code>in_progress</code>, or <code>completed</code>.
             </td>
           </tr>
           <tr>
diff --git a/cache/ghes-32/webhook-events-and-payloads.html b/cache/ghes-32/webhook-events-and-payloads.html
@@ -1651,8 +1651,8 @@ <h3 id="webhook-payload-object-1">
             <td><code>string</code></td>
             <td>
               The summary status for all check runs that are part of the check
-              suite. Can be <code>requested</code>, <code>in_progress</code>, or
-              <code>completed</code>.
+              suite. Can be <code>queued</code>, <code>requested</code>,
+              <code>in_progress</code>, or <code>completed</code>.
             </td>
           </tr>
           <tr>
diff --git a/cache/ghes-33/webhook-events-and-payloads.html b/cache/ghes-33/webhook-events-and-payloads.html
@@ -2016,8 +2016,8 @@ <h3 id="webhook-payload-object-2">
             <td><code>string</code></td>
             <td>
               The summary status for all check runs that are part of the check
-              suite. Can be <code>requested</code>, <code>in_progress</code>, or
-              <code>completed</code>.
+              suite. Can be <code>queued</code>, <code>requested</code>,
+              <code>in_progress</code>, or <code>completed</code>.
             </td>
           </tr>
           <tr>
diff --git a/cache/ghes-34/webhook-events-and-payloads.html b/cache/ghes-34/webhook-events-and-payloads.html
@@ -2309,8 +2309,8 @@ <h3 id="webhook-payload-object-3">
             <td><code>string</code></td>
             <td>
               The summary status for all check runs that are part of the check
-              suite. Can be <code>requested</code>, <code>in_progress</code>, or
-              <code>completed</code>.
+              suite. Can be <code>queued</code>, <code>requested</code>,
+              <code>in_progress</code>, or <code>completed</code>.
             </td>
           </tr>
           <tr>
diff --git a/cache/ghes-35/webhook-events-and-payloads.html b/cache/ghes-35/webhook-events-and-payloads.html
@@ -2322,8 +2322,8 @@ <h3 id="webhook-payload-object-3">
             <td><code>string</code></td>
             <td>
               The summary status for all check runs that are part of the check
-              suite. Can be <code>requested</code>, <code>in_progress</code>, or
-              <code>completed</code>.
+              suite. Can be <code>queued</code>, <code>requested</code>,
+              <code>in_progress</code>, or <code>completed</code>.
             </td>
           </tr>
           <tr>
diff --git a/cache/github.ae/webhook-events-and-payloads.html b/cache/github.ae/webhook-events-and-payloads.html
@@ -1933,8 +1933,8 @@ <h3 id="webhook-payload-object-2">
             <td><code>string</code></td>
             <td>
               The summary status for all check runs that are part of the check
-              suite. Can be <code>requested</code>, <code>in_progress</code>, or
-              <code>completed</code>.
+              suite. Can be <code>queued</code>, <code>requested</code>,
+              <code>in_progress</code>, or <code>completed</code>.
             </td>
           </tr>
           <tr>
diff --git a/payload-examples/api.github.com/index.json b/payload-examples/api.github.com/index.json
@@ -3431,7 +3431,7 @@
       },
       "check_suite[status]": {
         "type": "string",
-        "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
+        "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`."
       },
       "check_suite[conclusion]": {
         "type": "string",
diff --git a/payload-examples/ghes-32/index.json b/payload-examples/ghes-32/index.json
@@ -463,7 +463,7 @@
       },
       "check_suite[status]": {
         "type": "string",
-        "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
+        "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`."
       },
       "check_suite[conclusion]": {
         "type": "string",
diff --git a/payload-examples/ghes-33/index.json b/payload-examples/ghes-33/index.json
@@ -653,7 +653,7 @@
       },
       "check_suite[status]": {
         "type": "string",
-        "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
+        "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`."
       },
       "check_suite[conclusion]": {
         "type": "string",
diff --git a/payload-examples/ghes-34/index.json b/payload-examples/ghes-34/index.json
@@ -1725,7 +1725,7 @@
       },
       "check_suite[status]": {
         "type": "string",
-        "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
+        "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`."
       },
       "check_suite[conclusion]": {
         "type": "string",
diff --git a/payload-examples/ghes-35/index.json b/payload-examples/ghes-35/index.json
@@ -1725,7 +1725,7 @@
       },
       "check_suite[status]": {
         "type": "string",
-        "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
+        "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`."
       },
       "check_suite[conclusion]": {
         "type": "string",
diff --git a/payload-examples/github.ae/index.json b/payload-examples/github.ae/index.json
@@ -1463,7 +1463,7 @@
       },
       "check_suite[status]": {
         "type": "string",
-        "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
+        "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`."
       },
       "check_suite[conclusion]": {
         "type": "string",
diff --git a/payload-schemas/api.github.com/check_suite/completed.schema.json b/payload-schemas/api.github.com/check_suite/completed.schema.json
@@ -40,7 +40,7 @@
         "status": {
           "type": ["string", "null"],
           "enum": ["requested", "in_progress", "completed", "queued", null],
-          "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
+          "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`."
         },
         "conclusion": {
           "type": ["string", "null"],
diff --git a/payload-schemas/api.github.com/check_suite/requested.schema.json b/payload-schemas/api.github.com/check_suite/requested.schema.json
@@ -40,7 +40,7 @@
         "status": {
           "type": ["string", "null"],
           "enum": ["requested", "in_progress", "completed", "queued", null],
-          "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
+          "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`."
         },
         "conclusion": {
           "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
diff --git a/payload-schemas/api.github.com/check_suite/rerequested.schema.json b/payload-schemas/api.github.com/check_suite/rerequested.schema.json
@@ -40,7 +40,7 @@
         "status": {
           "type": ["string", "null"],
           "enum": ["requested", "in_progress", "completed", "queued", null],
-          "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
+          "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`."
         },
         "conclusion": {
           "type": ["string", "null"],
diff --git a/payload-types/schema.d.ts b/payload-types/schema.d.ts
@@ -1421,7 +1421,7 @@ export interface CheckSuiteCompletedEvent {
      */
     head_sha: string;
     /**
-     * The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+     * The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`.
      */
     status: "requested" | "in_progress" | "completed" | "queued" | null;
     /**
@@ -1500,7 +1500,7 @@ export interface CheckSuiteRequestedEvent {
      */
     head_sha: string;
     /**
-     * The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+     * The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`.
      */
     status: "requested" | "in_progress" | "completed" | "queued" | null;
     /**
@@ -1556,7 +1556,7 @@ export interface CheckSuiteRerequestedEvent {
      */
     head_sha: string;
     /**
-     * The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+     * The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`.
      */
     status: "requested" | "in_progress" | "completed" | "queued" | null;
     /**
