Skip to content

Commit ccf681e

Browse files
github-openapi-botgithub-openapi-bot
authored
Updating OpenAPI descriptions (#17234)
* Updating OpenAPI descriptions * Add decorated OpenAPI schema files
1 parent dc59c29 commit ccf681e

14 files changed

Lines changed: 29121 additions & 3458 deletions

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

Lines changed: 2025 additions & 182 deletions
Large diffs are not rendered by default.

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

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4513,10 +4513,11 @@
45134513
"name": "client_id",
45144514
"in": "path",
45154515
"required": true,
4516+
"description": "The client ID of your GitHub app.",
45164517
"schema": {
45174518
"type": "string"
45184519
},
4519-
"descriptionHTML": ""
4520+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
45204521
},
45214522
{
45224523
"name": "access_token",
@@ -4580,10 +4581,11 @@
45804581
"name": "client_id",
45814582
"in": "path",
45824583
"required": true,
4584+
"description": "The client ID of your GitHub app.",
45834585
"schema": {
45844586
"type": "string"
45854587
},
4586-
"descriptionHTML": ""
4588+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
45874589
},
45884590
{
45894591
"name": "access_token",
@@ -4648,10 +4650,11 @@
46484650
"name": "client_id",
46494651
"in": "path",
46504652
"required": true,
4653+
"description": "The client ID of your GitHub app.",
46514654
"schema": {
46524655
"type": "string"
46534656
},
4654-
"descriptionHTML": ""
4657+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
46554658
},
46564659
{
46574660
"name": "access_token",
@@ -4716,10 +4719,11 @@
47164719
"name": "client_id",
47174720
"in": "path",
47184721
"required": true,
4722+
"description": "The client ID of your GitHub app.",
47194723
"schema": {
47204724
"type": "string"
47214725
},
4722-
"descriptionHTML": ""
4726+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
47234727
},
47244728
{
47254729
"name": "access_token",
@@ -5175,10 +5179,11 @@
51755179
"name": "client_id",
51765180
"in": "path",
51775181
"required": true,
5182+
"description": "The client ID of your GitHub app.",
51785183
"schema": {
51795184
"type": "string"
51805185
},
5181-
"descriptionHTML": ""
5186+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
51825187
}
51835188
],
51845189
"x-codeSamples": [
@@ -5388,10 +5393,11 @@
53885393
"name": "client_id",
53895394
"in": "path",
53905395
"required": true,
5396+
"description": "The client ID of your GitHub app.",
53915397
"schema": {
53925398
"type": "string"
53935399
},
5394-
"descriptionHTML": ""
5400+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
53955401
},
53965402
{
53975403
"name": "fingerprint",

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

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4513,10 +4513,11 @@
45134513
"name": "client_id",
45144514
"in": "path",
45154515
"required": true,
4516+
"description": "The client ID of your GitHub app.",
45164517
"schema": {
45174518
"type": "string"
45184519
},
4519-
"descriptionHTML": ""
4520+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
45204521
},
45214522
{
45224523
"name": "access_token",
@@ -4580,10 +4581,11 @@
45804581
"name": "client_id",
45814582
"in": "path",
45824583
"required": true,
4584+
"description": "The client ID of your GitHub app.",
45834585
"schema": {
45844586
"type": "string"
45854587
},
4586-
"descriptionHTML": ""
4588+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
45874589
},
45884590
{
45894591
"name": "access_token",
@@ -4648,10 +4650,11 @@
46484650
"name": "client_id",
46494651
"in": "path",
46504652
"required": true,
4653+
"description": "The client ID of your GitHub app.",
46514654
"schema": {
46524655
"type": "string"
46534656
},
4654-
"descriptionHTML": ""
4657+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
46554658
},
46564659
{
46574660
"name": "access_token",
@@ -4716,10 +4719,11 @@
47164719
"name": "client_id",
47174720
"in": "path",
47184721
"required": true,
4722+
"description": "The client ID of your GitHub app.",
47194723
"schema": {
47204724
"type": "string"
47214725
},
4722-
"descriptionHTML": ""
4726+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
47234727
},
47244728
{
47254729
"name": "access_token",
@@ -5175,10 +5179,11 @@
51755179
"name": "client_id",
51765180
"in": "path",
51775181
"required": true,
5182+
"description": "The client ID of your GitHub app.",
51785183
"schema": {
51795184
"type": "string"
51805185
},
5181-
"descriptionHTML": ""
5186+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
51825187
}
51835188
],
51845189
"x-codeSamples": [
@@ -5388,10 +5393,11 @@
53885393
"name": "client_id",
53895394
"in": "path",
53905395
"required": true,
5396+
"description": "The client ID of your GitHub app.",
53915397
"schema": {
53925398
"type": "string"
53935399
},
5394-
"descriptionHTML": ""
5400+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
53955401
},
53965402
{
53975403
"name": "fingerprint",

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

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4506,10 +4506,11 @@
45064506
"name": "client_id",
45074507
"in": "path",
45084508
"required": true,
4509+
"description": "The client ID of your GitHub app.",
45094510
"schema": {
45104511
"type": "string"
45114512
},
4512-
"descriptionHTML": ""
4513+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
45134514
}
45144515
],
45154516
"x-codeSamples": [
@@ -4604,10 +4605,11 @@
46044605
"name": "client_id",
46054606
"in": "path",
46064607
"required": true,
4608+
"description": "The client ID of your GitHub app.",
46074609
"schema": {
46084610
"type": "string"
46094611
},
4610-
"descriptionHTML": ""
4612+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
46114613
},
46124614
{
46134615
"name": "access_token",
@@ -4676,10 +4678,11 @@
46764678
"name": "client_id",
46774679
"in": "path",
46784680
"required": true,
4681+
"description": "The client ID of your GitHub app.",
46794682
"schema": {
46804683
"type": "string"
46814684
},
4682-
"descriptionHTML": ""
4685+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
46834686
}
46844687
],
46854688
"x-codeSamples": [
@@ -4780,10 +4783,11 @@
47804783
"name": "client_id",
47814784
"in": "path",
47824785
"required": true,
4786+
"description": "The client ID of your GitHub app.",
47834787
"schema": {
47844788
"type": "string"
47854789
},
4786-
"descriptionHTML": ""
4790+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
47874791
}
47884792
],
47894793
"x-codeSamples": [
@@ -4879,10 +4883,11 @@
48794883
"name": "client_id",
48804884
"in": "path",
48814885
"required": true,
4886+
"description": "The client ID of your GitHub app.",
48824887
"schema": {
48834888
"type": "string"
48844889
},
4885-
"descriptionHTML": ""
4890+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
48864891
}
48874892
],
48884893
"x-codeSamples": [
@@ -4977,10 +4982,11 @@
49774982
"name": "client_id",
49784983
"in": "path",
49794984
"required": true,
4985+
"description": "The client ID of your GitHub app.",
49804986
"schema": {
49814987
"type": "string"
49824988
},
4983-
"descriptionHTML": ""
4989+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
49844990
},
49854991
{
49864992
"name": "access_token",
@@ -5055,10 +5061,11 @@
50555061
"name": "client_id",
50565062
"in": "path",
50575063
"required": true,
5064+
"description": "The client ID of your GitHub app.",
50585065
"schema": {
50595066
"type": "string"
50605067
},
5061-
"descriptionHTML": ""
5068+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
50625069
},
50635070
{
50645071
"name": "access_token",
@@ -5128,10 +5135,11 @@
51285135
"name": "client_id",
51295136
"in": "path",
51305137
"required": true,
5138+
"description": "The client ID of your GitHub app.",
51315139
"schema": {
51325140
"type": "string"
51335141
},
5134-
"descriptionHTML": ""
5142+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
51355143
},
51365144
{
51375145
"name": "access_token",
@@ -5592,10 +5600,11 @@
55925600
"name": "client_id",
55935601
"in": "path",
55945602
"required": true,
5603+
"description": "The client ID of your GitHub app.",
55955604
"schema": {
55965605
"type": "string"
55975606
},
5598-
"descriptionHTML": ""
5607+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
55995608
}
56005609
],
56015610
"x-codeSamples": [
@@ -5805,10 +5814,11 @@
58055814
"name": "client_id",
58065815
"in": "path",
58075816
"required": true,
5817+
"description": "The client ID of your GitHub app.",
58085818
"schema": {
58095819
"type": "string"
58105820
},
5811-
"descriptionHTML": ""
5821+
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
58125822
},
58135823
{
58145824
"name": "fingerprint",

0 commit comments

Comments
 (0)