Skip to content

Commit 389dd3b

Browse files
Update OpenAPI Description (#55380)
Co-authored-by: Sophie <[email protected]>
1 parent 1d56109 commit 389dd3b

File tree

10 files changed

+460
-149
lines changed

10 files changed

+460
-149
lines changed

src/github-apps/lib/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "a3b90207333d17877bcbab612a4163337ed7148c"
63+
"sha": "8af3e59120fdf6294e2d385bdae74b39fa824da5"
6464
}

src/rest/data/fpt-2022-11-28/schema.json

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144111,7 +144111,7 @@
144111144111
}
144112144112
],
144113144113
"previews": [],
144114-
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> event with the action <code>rerequested</code>. When a check run is <code>rerequested</code>, the <code>status</code> of the check suite it belongs to is reset to <code>queued</code> and the <code>conclusion</code> is cleared. The check run itself is not updated. GitHub apps recieving the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> with the <code>rerequested</code> action should then decide if the check run should be reset or updated and call the <a href=\"https://docs.github.com/rest/checks/runs#update-a-check-run\">update <code>check_run</code> endpoint</a> to update the check_run if desired.</p>\n<p>For more information about how to re-run GitHub Actions jobs, see \"<a href=\"https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run\">Re-run a job from a workflow run</a>\".</p>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>",
144114+
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> event with the action <code>rerequested</code>. When a check run is <code>rerequested</code>, the <code>status</code> of the check suite it belongs to is reset to <code>queued</code> and the <code>conclusion</code> is cleared. The check run itself is not updated. GitHub apps recieving the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> with the <code>rerequested</code> action should then decide if the check run should be reset or updated and call the <a href=\"https://docs.github.com/rest/checks/runs#update-a-check-run\">update <code>check_run</code> endpoint</a> to update the check_run if desired.</p>\n<p>For more information about how to re-run GitHub Actions jobs, see \"<a href=\"https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run\">Re-run a job from a workflow run</a>\".</p>",
144115144115
"statusCodes": [
144116144116
{
144117144117
"httpStatusCode": "201",
@@ -154379,7 +154379,7 @@
154379154379
}
154380154380
],
154381154381
"previews": [],
154382-
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_suite\"><code>check_suite</code> webhook</a> event with the action <code>rerequested</code>. When a check suite is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>",
154382+
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_suite\"><code>check_suite</code> webhook</a> event with the action <code>rerequested</code>. When a check suite is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>",
154383154383
"statusCodes": [
154384154384
{
154385154385
"httpStatusCode": "201",
@@ -243433,6 +243433,27 @@
243433243433
"type": "string"
243434243434
}
243435243435
},
243436+
{
243437+
"name": "has",
243438+
"in": "query",
243439+
"description": "<p>Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple <code>has</code> filters can be chained to check if multiple properties are present.</p>",
243440+
"schema": {
243441+
"oneOf": [
243442+
{
243443+
"type": "string"
243444+
},
243445+
{
243446+
"type": "array",
243447+
"items": {
243448+
"type": "string",
243449+
"enum": [
243450+
"patch"
243451+
]
243452+
}
243453+
}
243454+
]
243455+
}
243456+
},
243436243457
{
243437243458
"name": "scope",
243438243459
"in": "query",
@@ -245345,6 +245366,27 @@
245345245366
"type": "string"
245346245367
}
245347245368
},
245369+
{
245370+
"name": "has",
245371+
"in": "query",
245372+
"description": "<p>Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple <code>has</code> filters can be chained to check if multiple properties are present.</p>",
245373+
"schema": {
245374+
"oneOf": [
245375+
{
245376+
"type": "string"
245377+
},
245378+
{
245379+
"type": "array",
245380+
"items": {
245381+
"type": "string",
245382+
"enum": [
245383+
"patch"
245384+
]
245385+
}
245386+
}
245387+
]
245388+
}
245389+
},
245348245390
{
245349245391
"name": "scope",
245350245392
"in": "query",
@@ -247282,6 +247324,27 @@
247282247324
"type": "string"
247283247325
}
247284247326
},
247327+
{
247328+
"name": "has",
247329+
"in": "query",
247330+
"description": "<p>Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple <code>has</code> filters can be chained to check if multiple properties are present.</p>",
247331+
"schema": {
247332+
"oneOf": [
247333+
{
247334+
"type": "string"
247335+
},
247336+
{
247337+
"type": "array",
247338+
"items": {
247339+
"type": "string",
247340+
"enum": [
247341+
"patch"
247342+
]
247343+
}
247344+
}
247345+
]
247346+
}
247347+
},
247285247348
{
247286247349
"name": "scope",
247287247350
"in": "query",

src/rest/data/ghec-2022-11-28/schema.json

Lines changed: 67 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118107,7 +118107,7 @@
118107118107
{
118108118108
"name": "advanced_security_product",
118109118109
"in": "query",
118110-
"description": "<p>The security feature to get GitHub Advanced Security active committers for.</p>",
118110+
"description": "<p>The security product to get GitHub Advanced Security active committers for. This parameter is required if you have puchased standalone Code Scanning or Secret Protection products to specify which one you want to get the committer information for, otherwise it is not required.</p>",
118111118111
"required": false,
118112118112
"schema": {
118113118113
"type": "string",
@@ -153527,7 +153527,7 @@
153527153527
}
153528153528
],
153529153529
"previews": [],
153530-
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> event with the action <code>rerequested</code>. When a check run is <code>rerequested</code>, the <code>status</code> of the check suite it belongs to is reset to <code>queued</code> and the <code>conclusion</code> is cleared. The check run itself is not updated. GitHub apps recieving the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> with the <code>rerequested</code> action should then decide if the check run should be reset or updated and call the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run\">update <code>check_run</code> endpoint</a> to update the check_run if desired.</p>\n<p>For more information about how to re-run GitHub Actions jobs, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run\">Re-run a job from a workflow run</a>\".</p>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>",
153530+
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> event with the action <code>rerequested</code>. When a check run is <code>rerequested</code>, the <code>status</code> of the check suite it belongs to is reset to <code>queued</code> and the <code>conclusion</code> is cleared. The check run itself is not updated. GitHub apps recieving the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> with the <code>rerequested</code> action should then decide if the check run should be reset or updated and call the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run\">update <code>check_run</code> endpoint</a> to update the check_run if desired.</p>\n<p>For more information about how to re-run GitHub Actions jobs, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run\">Re-run a job from a workflow run</a>\".</p>",
153531153531
"statusCodes": [
153532153532
{
153533153533
"httpStatusCode": "201",
@@ -163843,7 +163843,7 @@
163843163843
}
163844163844
],
163845163845
"previews": [],
163846-
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite\"><code>check_suite</code> webhook</a> event with the action <code>rerequested</code>. When a check suite is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>",
163846+
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite\"><code>check_suite</code> webhook</a> event with the action <code>rerequested</code>. When a check suite is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>",
163847163847
"statusCodes": [
163848163848
{
163849163849
"httpStatusCode": "201",
@@ -256753,6 +256753,27 @@
256753256753
"type": "string"
256754256754
}
256755256755
},
256756+
{
256757+
"name": "has",
256758+
"in": "query",
256759+
"description": "<p>Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple <code>has</code> filters can be chained to check if multiple properties are present.</p>",
256760+
"schema": {
256761+
"oneOf": [
256762+
{
256763+
"type": "string"
256764+
},
256765+
{
256766+
"type": "array",
256767+
"items": {
256768+
"type": "string",
256769+
"enum": [
256770+
"patch"
256771+
]
256772+
}
256773+
}
256774+
]
256775+
}
256776+
},
256756256777
{
256757256778
"name": "scope",
256758256779
"in": "query",
@@ -258665,6 +258686,27 @@
258665258686
"type": "string"
258666258687
}
258667258688
},
258689+
{
258690+
"name": "has",
258691+
"in": "query",
258692+
"description": "<p>Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple <code>has</code> filters can be chained to check if multiple properties are present.</p>",
258693+
"schema": {
258694+
"oneOf": [
258695+
{
258696+
"type": "string"
258697+
},
258698+
{
258699+
"type": "array",
258700+
"items": {
258701+
"type": "string",
258702+
"enum": [
258703+
"patch"
258704+
]
258705+
}
258706+
}
258707+
]
258708+
}
258709+
},
258668258710
{
258669258711
"name": "scope",
258670258712
"in": "query",
@@ -260602,6 +260644,27 @@
260602260644
"type": "string"
260603260645
}
260604260646
},
260647+
{
260648+
"name": "has",
260649+
"in": "query",
260650+
"description": "<p>Filters the list of alerts based on whether the alert has a patch. If specified, only alerts with a patch will be returned.\nMultiple <code>has</code> filters can be chained to check if multiple properties are present.</p>",
260651+
"schema": {
260652+
"oneOf": [
260653+
{
260654+
"type": "string"
260655+
},
260656+
{
260657+
"type": "array",
260658+
"items": {
260659+
"type": "string",
260660+
"enum": [
260661+
"patch"
260662+
]
260663+
}
260664+
}
260665+
]
260666+
}
260667+
},
260605260668
{
260606260669
"name": "scope",
260607260670
"in": "query",
@@ -281318,7 +281381,7 @@
281318281381
{
281319281382
"name": "advanced_security_product",
281320281383
"in": "query",
281321-
"description": "<p>The security feature to get GitHub Advanced Security active committers for.</p>",
281384+
"description": "<p>The security product to get GitHub Advanced Security active committers for. This parameter is required if you have puchased standalone Code Scanning or Secret Protection products to specify which one you want to get the committer information for, otherwise it is not required.</p>",
281322281385
"required": false,
281323281386
"schema": {
281324281387
"type": "string",

0 commit comments

Comments
 (0)