FEAT: updates docs, updates workflow-run-requested[hub_url is no long…

…er required], adds values to job.status enum [waiting, requested, pending]
octokit · Mar 15, 2024 · 0509599 · 0509599
2 parents 43b9072 + 7ddb34c
commit 0509599
Show file tree

Hide file tree

Showing 7 changed files with 231 additions and 49 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
@@ -18590,7 +18590,11 @@
           "followers_url": { "type": "string", "format": "uri-template" },
           "following_url": { "type": "string", "format": "uri-template" },
           "gists_url": { "type": "string", "format": "uri-template" },
-          "hub_url": { "type": "string", "format": "uri-template" },
+          "hub_url": {
+            "type": "string",
+            "format": "uri-template",
+            "deprecated": true
+          },
           "issue_search_url": { "type": "string", "format": "uri-template" },
           "issues_url": { "type": "string", "format": "uri-template" },
           "keys_url": { "type": "string", "format": "uri-template" },
@@ -18643,7 +18647,6 @@
           "followers_url",
           "following_url",
           "gists_url",
-          "hub_url",
           "issue_search_url",
           "issues_url",
           "keys_url",
@@ -29363,7 +29366,14 @@
           "status": {
             "description": "The phase of the lifecycle that the job is currently in.",
             "type": "string",
-            "enum": ["queued", "in_progress", "completed", "waiting"],
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending"
+            ],
             "examples": ["queued"]
           },
           "conclusion": {
@@ -31434,9 +31444,16 @@
             "examples": ["https://example.com"]
           },
           "status": {
-            "description": "The phase of the lifecycle that the check is currently in.",
+            "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
             "type": "string",
-            "enum": ["queued", "in_progress", "completed"],
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending"
+            ],
             "examples": ["queued"]
           },
           "conclusion": {
@@ -31578,7 +31595,16 @@
           },
           "status": {
             "type": ["string", "null"],
-            "enum": ["queued", "in_progress", "completed", null],
+            "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.",
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending",
+              null
+            ],
             "examples": ["completed"]
           },
           "conclusion": {
@@ -163787,7 +163813,7 @@
       },
       "workflow-run-status": {
         "name": "status",
-        "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
+        "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
         "in": "query",
         "required": false,
         "schema": {

diff --git a/cache/ghec.json b/cache/ghec.json
@@ -18596,7 +18596,11 @@
           "followers_url": { "type": "string", "format": "uri-template" },
           "following_url": { "type": "string", "format": "uri-template" },
           "gists_url": { "type": "string", "format": "uri-template" },
-          "hub_url": { "type": "string", "format": "uri-template" },
+          "hub_url": {
+            "type": "string",
+            "format": "uri-template",
+            "deprecated": true
+          },
           "issue_search_url": { "type": "string", "format": "uri-template" },
           "issues_url": { "type": "string", "format": "uri-template" },
           "keys_url": { "type": "string", "format": "uri-template" },
@@ -18649,7 +18653,6 @@
           "followers_url",
           "following_url",
           "gists_url",
-          "hub_url",
           "issue_search_url",
           "issues_url",
           "keys_url",
@@ -30410,7 +30413,14 @@
           "status": {
             "description": "The phase of the lifecycle that the job is currently in.",
             "type": "string",
-            "enum": ["queued", "in_progress", "completed", "waiting"],
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending"
+            ],
             "examples": ["queued"]
           },
           "conclusion": {
@@ -32481,9 +32491,16 @@
             "examples": ["https://example.com"]
           },
           "status": {
-            "description": "The phase of the lifecycle that the check is currently in.",
+            "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
             "type": "string",
-            "enum": ["queued", "in_progress", "completed"],
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending"
+            ],
             "examples": ["queued"]
           },
           "conclusion": {
@@ -32625,7 +32642,16 @@
           },
           "status": {
             "type": ["string", "null"],
-            "enum": ["queued", "in_progress", "completed", null],
+            "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.",
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending",
+              null
+            ],
             "examples": ["completed"]
           },
           "conclusion": {
@@ -166555,7 +166581,7 @@
       },
       "workflow-run-status": {
         "name": "status",
-        "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
+        "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
         "in": "query",
         "required": false,
         "schema": {

diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json
@@ -19821,7 +19821,11 @@
           "followers_url": { "type": "string", "format": "uri-template" },
           "following_url": { "type": "string", "format": "uri-template" },
           "gists_url": { "type": "string", "format": "uri-template" },
-          "hub_url": { "type": "string", "format": "uri-template" },
+          "hub_url": {
+            "type": "string",
+            "format": "uri-template",
+            "deprecated": true
+          },
           "issue_search_url": { "type": "string", "format": "uri-template" },
           "issues_url": { "type": "string", "format": "uri-template" },
           "keys_url": { "type": "string", "format": "uri-template" },
@@ -19874,7 +19878,6 @@
           "followers_url",
           "following_url",
           "gists_url",
-          "hub_url",
           "issue_search_url",
           "issues_url",
           "keys_url",
@@ -28912,7 +28915,14 @@
           "status": {
             "description": "The phase of the lifecycle that the job is currently in.",
             "type": "string",
-            "enum": ["queued", "in_progress", "completed", "waiting"],
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending"
+            ],
             "examples": ["queued"]
           },
           "conclusion": {
@@ -30825,9 +30835,16 @@
             "examples": ["https://example.com"]
           },
           "status": {
-            "description": "The phase of the lifecycle that the check is currently in.",
+            "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
             "type": "string",
-            "enum": ["queued", "in_progress", "completed"],
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending"
+            ],
             "examples": ["queued"]
           },
           "conclusion": {
@@ -30969,7 +30986,16 @@
           },
           "status": {
             "type": ["string", "null"],
-            "enum": ["queued", "in_progress", "completed", null],
+            "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.",
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending",
+              null
+            ],
             "examples": ["completed"]
           },
           "conclusion": {
@@ -154911,7 +154937,7 @@
       },
       "workflow-run-status": {
         "name": "status",
-        "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
+        "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
         "in": "query",
         "required": false,
         "schema": {

diff --git a/cache/ghes-3.11.json b/cache/ghes-3.11.json
@@ -20196,7 +20196,11 @@
           "followers_url": { "type": "string", "format": "uri-template" },
           "following_url": { "type": "string", "format": "uri-template" },
           "gists_url": { "type": "string", "format": "uri-template" },
-          "hub_url": { "type": "string", "format": "uri-template" },
+          "hub_url": {
+            "type": "string",
+            "format": "uri-template",
+            "deprecated": true
+          },
           "issue_search_url": { "type": "string", "format": "uri-template" },
           "issues_url": { "type": "string", "format": "uri-template" },
           "keys_url": { "type": "string", "format": "uri-template" },
@@ -20249,7 +20253,6 @@
           "followers_url",
           "following_url",
           "gists_url",
-          "hub_url",
           "issue_search_url",
           "issues_url",
           "keys_url",
@@ -30218,7 +30221,14 @@
           "status": {
             "description": "The phase of the lifecycle that the job is currently in.",
             "type": "string",
-            "enum": ["queued", "in_progress", "completed", "waiting"],
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending"
+            ],
             "examples": ["queued"]
           },
           "conclusion": {
@@ -32193,9 +32203,16 @@
             "examples": ["https://example.com"]
           },
           "status": {
-            "description": "The phase of the lifecycle that the check is currently in.",
+            "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
             "type": "string",
-            "enum": ["queued", "in_progress", "completed"],
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending"
+            ],
             "examples": ["queued"]
           },
           "conclusion": {
@@ -32337,7 +32354,16 @@
           },
           "status": {
             "type": ["string", "null"],
-            "enum": ["queued", "in_progress", "completed", null],
+            "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.",
+            "enum": [
+              "queued",
+              "in_progress",
+              "completed",
+              "waiting",
+              "requested",
+              "pending",
+              null
+            ],
             "examples": ["completed"]
           },
           "conclusion": {
@@ -156988,7 +157014,7 @@
       },
       "workflow-run-status": {
         "name": "status",
-        "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
+        "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
         "in": "query",
         "required": false,
         "schema": {