Skip to content

Commit c00ba68

Browse files
github-openapi-botgithub-openapi-bot
committed
fix: Update the OpenAPI description to the latest version
1 parent c43cf30 commit c00ba68

24 files changed

+120
-56
lines changed

‎descriptions/api.github.com/api.github.com.json

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.1.0",
4+
"version": "1.1.1",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -21107,7 +21107,7 @@
2110721107
"/repos/{owner}/{repo}/check-runs": {
2110821108
"post": {
2110921109
"summary": "Create a check run",
21110-
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
21110+
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
2111121111
"tags": [
2111221112
"checks"
2111321113
],
@@ -22197,7 +22197,7 @@
2219722197
}
2219822198
},
2219922199
"404": {
22200-
"description": "Response if the ref doesn't match an existing ref"
22200+
"description": "Response if the ref does not match an existing ref"
2220122201
},
2220222202
"503": {
2220322203
"$ref": "#/components/responses/service_unavailable"
@@ -22337,8 +22337,11 @@
2233722337
}
2233822338
}
2233922339
},
22340+
"403": {
22341+
"description": "Response if the repository is archived"
22342+
},
2234022343
"503": {
22341-
"description": "When code scanning isn't available you can try again at a later time"
22344+
"description": "Response when code scanning is not available and you should try again at a later time"
2234222345
}
2234322346
},
2234422347
"x-github": {
@@ -22489,6 +22492,9 @@
2248922492
"202": {
2249022493
"description": "response"
2249122494
},
22495+
"403": {
22496+
"description": "Response if the repository is archived"
22497+
},
2249222498
"404": {
2249322499
"description": "Response if `commit_sha` or `ref` cannot be found"
2249422500
}

‎descriptions/api.github.com/api.github.com.yaml

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 1.1.0
4+
version: 1.1.1
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -15130,6 +15130,8 @@ paths:
1513015130
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
1513115131

1513215132
Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
15133+
15134+
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
1513315135
tags:
1513415136
- checks
1513515137
operationId: checks/create
@@ -15993,7 +15995,7 @@ paths:
1599315995
default:
1599415996
"$ref": "#/components/examples/code-scanning-alert-code-scanning-alert-items"
1599515997
'404':
15996-
description: Response if the ref doesn't match an existing ref
15998+
description: Response if the ref does not match an existing ref
1599715999
'503':
1599816000
"$ref": "#/components/responses/service_unavailable"
1599916001
x-github:
@@ -16083,9 +16085,11 @@ paths:
1608316085
examples:
1608416086
default:
1608516087
"$ref": "#/components/examples/code-scanning-alert-code-scanning-alert-dismissed"
16088+
'403':
16089+
description: Response if the repository is archived
1608616090
'503':
16087-
description: When code scanning isn't available you can try again at a later
16088-
time
16091+
description: Response when code scanning is not available and you should
16092+
try again at a later time
1608916093
x-github:
1609016094
enabledForApps: true
1609116095
githubCloudOnly: false
@@ -16193,6 +16197,8 @@ paths:
1619316197
responses:
1619416198
'202':
1619516199
description: response
16200+
'403':
16201+
description: Response if the repository is archived
1619616202
'404':
1619716203
description: Response if `commit_sha` or `ref` cannot be found
1619816204
x-github:

‎descriptions/api.github.com/dereferenced/api.github.com.deref.json

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.1.0",
4+
"version": "1.1.1",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -116148,7 +116148,7 @@
116148116148
"/repos/{owner}/{repo}/check-runs": {
116149116149
"post": {
116150116150
"summary": "Create a check run",
116151-
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
116151+
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
116152116152
"tags": [
116153116153
"checks"
116154116154
],
@@ -123639,7 +123639,7 @@
123639123639
}
123640123640
},
123641123641
"404": {
123642-
"description": "Response if the ref doesn't match an existing ref"
123642+
"description": "Response if the ref does not match an existing ref"
123643123643
},
123644123644
"503": {
123645123645
"description": "Service Unavailable",
@@ -124500,8 +124500,11 @@
124500124500
}
124501124501
}
124502124502
},
124503+
"403": {
124504+
"description": "Response if the repository is archived"
124505+
},
124503124506
"503": {
124504-
"description": "When code scanning isn't available you can try again at a later time"
124507+
"description": "Response when code scanning is not available and you should try again at a later time"
124505124508
}
124506124509
},
124507124510
"x-github": {
@@ -124736,6 +124739,9 @@
124736124739
"202": {
124737124740
"description": "response"
124738124741
},
124742+
"403": {
124743+
"description": "Response if the repository is archived"
124744+
},
124739124745
"404": {
124740124746
"description": "Response if `commit_sha` or `ref` cannot be found"
124741124747
}

‎descriptions/api.github.com/dereferenced/api.github.com.deref.yaml

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 1.1.0
4+
version: 1.1.1
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -88850,6 +88850,8 @@ paths:
8885088850
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
8885188851

8885288852
Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
88853+
88854+
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
8885388855
tags:
8885488856
- checks
8885588857
operationId: checks/create
@@ -94780,7 +94782,7 @@ paths:
9478094782
name: CodeQL command-line toolchain
9478194783
version:
9478294784
'404':
94783-
description: Response if the ref doesn't match an existing ref
94785+
description: Response if the ref does not match an existing ref
9478494786
'503':
9478594787
description: Service Unavailable
9478694788
content:
@@ -95444,9 +95446,11 @@ paths:
9544495446
tool:
9544595447
name: CodeQL command-line toolchain
9544695448
version:
95449+
'403':
95450+
description: Response if the repository is archived
9544795451
'503':
95448-
description: When code scanning isn't available you can try again at a later
95449-
time
95452+
description: Response when code scanning is not available and you should
95453+
try again at a later time
9545095454
x-github:
9545195455
enabledForApps: true
9545295456
githubCloudOnly: false
@@ -95634,6 +95638,8 @@ paths:
9563495638
responses:
9563595639
'202':
9563695640
description: response
95641+
'403':
95642+
description: Response if the repository is archived
9563795643
'404':
9563895644
description: Response if `commit_sha` or `ref` cannot be found
9563995645
x-github:

‎descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.1.0",
4+
"version": "1.1.1",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -74516,7 +74516,7 @@
7451674516
"/repos/{owner}/{repo}/check-runs": {
7451774517
"post": {
7451874518
"summary": "Create a check run",
74519-
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
74519+
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
7452074520
"tags": [
7452174521
"checks"
7452274522
],

‎descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 1.1.0
4+
version: 1.1.1
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -56631,6 +56631,8 @@ paths:
5663156631
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
5663256632

5663356633
Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
56634+
56635+
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
5663456636
tags:
5663556637
- checks
5663656638
operationId: checks/create

‎descriptions/ghes-2.18/ghes-2.18.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.1.0",
4+
"version": "1.1.1",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -13536,7 +13536,7 @@
1353613536
"/repos/{owner}/{repo}/check-runs": {
1353713537
"post": {
1353813538
"summary": "Create a check run",
13539-
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
13539+
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
1354013540
"tags": [
1354113541
"checks"
1354213542
],

‎descriptions/ghes-2.18/ghes-2.18.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 1.1.0
4+
version: 1.1.1
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -9747,6 +9747,8 @@ paths:
97479747
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
97489748

97499749
Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
9750+
9751+
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
97509752
tags:
97519753
- checks
97529754
operationId: checks/create

‎descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.1.0",
4+
"version": "1.1.1",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -77401,7 +77401,7 @@
7740177401
"/repos/{owner}/{repo}/check-runs": {
7740277402
"post": {
7740377403
"summary": "Create a check run",
77404-
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
77404+
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
7740577405
"tags": [
7740677406
"checks"
7740777407
],

‎descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 1.1.0
4+
version: 1.1.1
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -58803,6 +58803,8 @@ paths:
5880358803
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
5880458804

5880558805
Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
58806+
58807+
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
5880658808
tags:
5880758809
- checks
5880858810
operationId: checks/create

‎descriptions/ghes-2.19/ghes-2.19.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.1.0",
4+
"version": "1.1.1",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -13873,7 +13873,7 @@
1387313873
"/repos/{owner}/{repo}/check-runs": {
1387413874
"post": {
1387513875
"summary": "Create a check run",
13876-
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
13876+
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
1387713877
"tags": [
1387813878
"checks"
1387913879
],

‎descriptions/ghes-2.19/ghes-2.19.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 1.1.0
4+
version: 1.1.1
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -9976,6 +9976,8 @@ paths:
99769976
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
99779977

99789978
Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
9979+
9980+
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
99799981
tags:
99809982
- checks
99819983
operationId: checks/create

‎descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.1.0",
4+
"version": "1.1.1",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -78496,7 +78496,7 @@
7849678496
"/repos/{owner}/{repo}/check-runs": {
7849778497
"post": {
7849878498
"summary": "Create a check run",
78499-
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
78499+
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
7850078500
"tags": [
7850178501
"checks"
7850278502
],

‎descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 1.1.0
4+
version: 1.1.1
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -59776,6 +59776,8 @@ paths:
5977659776
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
5977759777

5977859778
Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
59779+
59780+
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
5977959781
tags:
5978059782
- checks
5978159783
operationId: checks/create

0 commit comments

Comments
 (0)