Skip to content

Commit 7e862d6

Browse files
github-openapi-botgithub-openapi-bot
authored
Update OpenAPI Descriptions (github#17697)
* Update OpenAPI Descriptions * Add decorated OpenAPI schema files
1 parent a5058af commit 7e862d6

16 files changed

+1214
-314
lines changed

‎lib/rest/static/decorated/api.github.com.json

Lines changed: 56 additions & 32 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.18.json

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23969,20 +23969,21 @@
2396923969
},
2397023970
"conclusion": {
2397123971
"type": "string",
23972-
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
23972+
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
2397323973
"enum": [
23974-
"success",
23974+
"action_required",
23975+
"cancelled",
2397523976
"failure",
2397623977
"neutral",
23977-
"cancelled",
23978+
"success",
2397823979
"skipped",
23979-
"timed_out",
23980-
"action_required"
23980+
"stale",
23981+
"timed_out"
2398123982
],
2398223983
"name": "conclusion",
2398323984
"in": "body",
2398423985
"rawType": "string",
23985-
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
23986+
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
2398623987
"childParamsGroups": []
2398723988
},
2398823989
"completed_at": {
@@ -25053,20 +25054,21 @@
2505325054
},
2505425055
{
2505525056
"type": "string",
25056-
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
25057+
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
2505725058
"enum": [
25058-
"success",
25059+
"action_required",
25060+
"cancelled",
2505925061
"failure",
2506025062
"neutral",
25061-
"cancelled",
25063+
"success",
2506225064
"skipped",
25063-
"timed_out",
25064-
"action_required"
25065+
"stale",
25066+
"timed_out"
2506525067
],
2506625068
"name": "conclusion",
2506725069
"in": "body",
2506825070
"rawType": "string",
25069-
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
25071+
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
2507025072
"childParamsGroups": []
2507125073
},
2507225074
{
@@ -26141,20 +26143,21 @@
2614126143
},
2614226144
"conclusion": {
2614326145
"type": "string",
26144-
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
26146+
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
2614526147
"enum": [
26146-
"success",
26148+
"action_required",
26149+
"cancelled",
2614726150
"failure",
2614826151
"neutral",
26149-
"cancelled",
26152+
"success",
2615026153
"skipped",
26151-
"timed_out",
26152-
"action_required"
26154+
"stale",
26155+
"timed_out"
2615326156
],
2615426157
"name": "conclusion",
2615526158
"in": "body",
2615626159
"rawType": "string",
26157-
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
26160+
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
2615826161
"childParamsGroups": []
2615926162
},
2616026163
"completed_at": {
@@ -27176,20 +27179,21 @@
2717627179
},
2717727180
{
2717827181
"type": "string",
27179-
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
27182+
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
2718027183
"enum": [
27181-
"success",
27184+
"action_required",
27185+
"cancelled",
2718227186
"failure",
2718327187
"neutral",
27184-
"cancelled",
27188+
"success",
2718527189
"skipped",
27186-
"timed_out",
27187-
"action_required"
27190+
"stale",
27191+
"timed_out"
2718827192
],
2718927193
"name": "conclusion",
2719027194
"in": "body",
2719127195
"rawType": "string",
27192-
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
27196+
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
2719327197
"childParamsGroups": []
2719427198
},
2719527199
{

0 commit comments

Comments
 (0)