Skip to content

Commit 0509599

Browse files
nickfloydnickfloyd
authored
FEAT: updates docs, updates workflow-run-requested[hub_url is no longer required], adds values to job.status enum [waiting, requested, pending]
2 parents 43b9072 + 7ddb34c commit 0509599

File tree

7 files changed

+231
-49
lines changed

7 files changed

+231
-49
lines changed

‎cache/api.github.com.json

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18590,7 +18590,11 @@
1859018590
"followers_url": { "type": "string", "format": "uri-template" },
1859118591
"following_url": { "type": "string", "format": "uri-template" },
1859218592
"gists_url": { "type": "string", "format": "uri-template" },
18593-
"hub_url": { "type": "string", "format": "uri-template" },
18593+
"hub_url": {
18594+
"type": "string",
18595+
"format": "uri-template",
18596+
"deprecated": true
18597+
},
1859418598
"issue_search_url": { "type": "string", "format": "uri-template" },
1859518599
"issues_url": { "type": "string", "format": "uri-template" },
1859618600
"keys_url": { "type": "string", "format": "uri-template" },
@@ -18643,7 +18647,6 @@
1864318647
"followers_url",
1864418648
"following_url",
1864518649
"gists_url",
18646-
"hub_url",
1864718650
"issue_search_url",
1864818651
"issues_url",
1864918652
"keys_url",
@@ -29363,7 +29366,14 @@
2936329366
"status": {
2936429367
"description": "The phase of the lifecycle that the job is currently in.",
2936529368
"type": "string",
29366-
"enum": ["queued", "in_progress", "completed", "waiting"],
29369+
"enum": [
29370+
"queued",
29371+
"in_progress",
29372+
"completed",
29373+
"waiting",
29374+
"requested",
29375+
"pending"
29376+
],
2936729377
"examples": ["queued"]
2936829378
},
2936929379
"conclusion": {
@@ -31434,9 +31444,16 @@
3143431444
"examples": ["https://example.com"]
3143531445
},
3143631446
"status": {
31437-
"description": "The phase of the lifecycle that the check is currently in.",
31447+
"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.",
3143831448
"type": "string",
31439-
"enum": ["queued", "in_progress", "completed"],
31449+
"enum": [
31450+
"queued",
31451+
"in_progress",
31452+
"completed",
31453+
"waiting",
31454+
"requested",
31455+
"pending"
31456+
],
3144031457
"examples": ["queued"]
3144131458
},
3144231459
"conclusion": {
@@ -31578,7 +31595,16 @@
3157831595
},
3157931596
"status": {
3158031597
"type": ["string", "null"],
31581-
"enum": ["queued", "in_progress", "completed", null],
31598+
"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.",
31599+
"enum": [
31600+
"queued",
31601+
"in_progress",
31602+
"completed",
31603+
"waiting",
31604+
"requested",
31605+
"pending",
31606+
null
31607+
],
3158231608
"examples": ["completed"]
3158331609
},
3158431610
"conclusion": {
@@ -163787,7 +163813,7 @@
163787163813
},
163788163814
"workflow-run-status": {
163789163815
"name": "status",
163790-
"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`.",
163816+
"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`.",
163791163817
"in": "query",
163792163818
"required": false,
163793163819
"schema": {

‎cache/ghec.json

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18596,7 +18596,11 @@
1859618596
"followers_url": { "type": "string", "format": "uri-template" },
1859718597
"following_url": { "type": "string", "format": "uri-template" },
1859818598
"gists_url": { "type": "string", "format": "uri-template" },
18599-
"hub_url": { "type": "string", "format": "uri-template" },
18599+
"hub_url": {
18600+
"type": "string",
18601+
"format": "uri-template",
18602+
"deprecated": true
18603+
},
1860018604
"issue_search_url": { "type": "string", "format": "uri-template" },
1860118605
"issues_url": { "type": "string", "format": "uri-template" },
1860218606
"keys_url": { "type": "string", "format": "uri-template" },
@@ -18649,7 +18653,6 @@
1864918653
"followers_url",
1865018654
"following_url",
1865118655
"gists_url",
18652-
"hub_url",
1865318656
"issue_search_url",
1865418657
"issues_url",
1865518658
"keys_url",
@@ -30410,7 +30413,14 @@
3041030413
"status": {
3041130414
"description": "The phase of the lifecycle that the job is currently in.",
3041230415
"type": "string",
30413-
"enum": ["queued", "in_progress", "completed", "waiting"],
30416+
"enum": [
30417+
"queued",
30418+
"in_progress",
30419+
"completed",
30420+
"waiting",
30421+
"requested",
30422+
"pending"
30423+
],
3041430424
"examples": ["queued"]
3041530425
},
3041630426
"conclusion": {
@@ -32481,9 +32491,16 @@
3248132491
"examples": ["https://example.com"]
3248232492
},
3248332493
"status": {
32484-
"description": "The phase of the lifecycle that the check is currently in.",
32494+
"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.",
3248532495
"type": "string",
32486-
"enum": ["queued", "in_progress", "completed"],
32496+
"enum": [
32497+
"queued",
32498+
"in_progress",
32499+
"completed",
32500+
"waiting",
32501+
"requested",
32502+
"pending"
32503+
],
3248732504
"examples": ["queued"]
3248832505
},
3248932506
"conclusion": {
@@ -32625,7 +32642,16 @@
3262532642
},
3262632643
"status": {
3262732644
"type": ["string", "null"],
32628-
"enum": ["queued", "in_progress", "completed", null],
32645+
"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.",
32646+
"enum": [
32647+
"queued",
32648+
"in_progress",
32649+
"completed",
32650+
"waiting",
32651+
"requested",
32652+
"pending",
32653+
null
32654+
],
3262932655
"examples": ["completed"]
3263032656
},
3263132657
"conclusion": {
@@ -166555,7 +166581,7 @@
166555166581
},
166556166582
"workflow-run-status": {
166557166583
"name": "status",
166558-
"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`.",
166584+
"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`.",
166559166585
"in": "query",
166560166586
"required": false,
166561166587
"schema": {

‎cache/ghes-3.10.json

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19821,7 +19821,11 @@
1982119821
"followers_url": { "type": "string", "format": "uri-template" },
1982219822
"following_url": { "type": "string", "format": "uri-template" },
1982319823
"gists_url": { "type": "string", "format": "uri-template" },
19824-
"hub_url": { "type": "string", "format": "uri-template" },
19824+
"hub_url": {
19825+
"type": "string",
19826+
"format": "uri-template",
19827+
"deprecated": true
19828+
},
1982519829
"issue_search_url": { "type": "string", "format": "uri-template" },
1982619830
"issues_url": { "type": "string", "format": "uri-template" },
1982719831
"keys_url": { "type": "string", "format": "uri-template" },
@@ -19874,7 +19878,6 @@
1987419878
"followers_url",
1987519879
"following_url",
1987619880
"gists_url",
19877-
"hub_url",
1987819881
"issue_search_url",
1987919882
"issues_url",
1988019883
"keys_url",
@@ -28912,7 +28915,14 @@
2891228915
"status": {
2891328916
"description": "The phase of the lifecycle that the job is currently in.",
2891428917
"type": "string",
28915-
"enum": ["queued", "in_progress", "completed", "waiting"],
28918+
"enum": [
28919+
"queued",
28920+
"in_progress",
28921+
"completed",
28922+
"waiting",
28923+
"requested",
28924+
"pending"
28925+
],
2891628926
"examples": ["queued"]
2891728927
},
2891828928
"conclusion": {
@@ -30825,9 +30835,16 @@
3082530835
"examples": ["https://example.com"]
3082630836
},
3082730837
"status": {
30828-
"description": "The phase of the lifecycle that the check is currently in.",
30838+
"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.",
3082930839
"type": "string",
30830-
"enum": ["queued", "in_progress", "completed"],
30840+
"enum": [
30841+
"queued",
30842+
"in_progress",
30843+
"completed",
30844+
"waiting",
30845+
"requested",
30846+
"pending"
30847+
],
3083130848
"examples": ["queued"]
3083230849
},
3083330850
"conclusion": {
@@ -30969,7 +30986,16 @@
3096930986
},
3097030987
"status": {
3097130988
"type": ["string", "null"],
30972-
"enum": ["queued", "in_progress", "completed", null],
30989+
"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.",
30990+
"enum": [
30991+
"queued",
30992+
"in_progress",
30993+
"completed",
30994+
"waiting",
30995+
"requested",
30996+
"pending",
30997+
null
30998+
],
3097330999
"examples": ["completed"]
3097431000
},
3097531001
"conclusion": {
@@ -154911,7 +154937,7 @@
154911154937
},
154912154938
"workflow-run-status": {
154913154939
"name": "status",
154914-
"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`.",
154940+
"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`.",
154915154941
"in": "query",
154916154942
"required": false,
154917154943
"schema": {

‎cache/ghes-3.11.json

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20196,7 +20196,11 @@
2019620196
"followers_url": { "type": "string", "format": "uri-template" },
2019720197
"following_url": { "type": "string", "format": "uri-template" },
2019820198
"gists_url": { "type": "string", "format": "uri-template" },
20199-
"hub_url": { "type": "string", "format": "uri-template" },
20199+
"hub_url": {
20200+
"type": "string",
20201+
"format": "uri-template",
20202+
"deprecated": true
20203+
},
2020020204
"issue_search_url": { "type": "string", "format": "uri-template" },
2020120205
"issues_url": { "type": "string", "format": "uri-template" },
2020220206
"keys_url": { "type": "string", "format": "uri-template" },
@@ -20249,7 +20253,6 @@
2024920253
"followers_url",
2025020254
"following_url",
2025120255
"gists_url",
20252-
"hub_url",
2025320256
"issue_search_url",
2025420257
"issues_url",
2025520258
"keys_url",
@@ -30218,7 +30221,14 @@
3021830221
"status": {
3021930222
"description": "The phase of the lifecycle that the job is currently in.",
3022030223
"type": "string",
30221-
"enum": ["queued", "in_progress", "completed", "waiting"],
30224+
"enum": [
30225+
"queued",
30226+
"in_progress",
30227+
"completed",
30228+
"waiting",
30229+
"requested",
30230+
"pending"
30231+
],
3022230232
"examples": ["queued"]
3022330233
},
3022430234
"conclusion": {
@@ -32193,9 +32203,16 @@
3219332203
"examples": ["https://example.com"]
3219432204
},
3219532205
"status": {
32196-
"description": "The phase of the lifecycle that the check is currently in.",
32206+
"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.",
3219732207
"type": "string",
32198-
"enum": ["queued", "in_progress", "completed"],
32208+
"enum": [
32209+
"queued",
32210+
"in_progress",
32211+
"completed",
32212+
"waiting",
32213+
"requested",
32214+
"pending"
32215+
],
3219932216
"examples": ["queued"]
3220032217
},
3220132218
"conclusion": {
@@ -32337,7 +32354,16 @@
3233732354
},
3233832355
"status": {
3233932356
"type": ["string", "null"],
32340-
"enum": ["queued", "in_progress", "completed", null],
32357+
"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.",
32358+
"enum": [
32359+
"queued",
32360+
"in_progress",
32361+
"completed",
32362+
"waiting",
32363+
"requested",
32364+
"pending",
32365+
null
32366+
],
3234132367
"examples": ["completed"]
3234232368
},
3234332369
"conclusion": {
@@ -156988,7 +157014,7 @@
156988157014
},
156989157015
"workflow-run-status": {
156990157016
"name": "status",
156991-
"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`.",
157017+
"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`.",
156992157018
"in": "query",
156993157019
"required": false,
156994157020
"schema": {

0 commit comments

Comments
 (0)