Skip to content

Commit 62a8f70

Browse files
Update OpenAPI Descriptions (#17970)
* Update OpenAPI Descriptions * Add decorated OpenAPI schema files
1 parent c371e18 commit 62a8f70

File tree

11 files changed

+20757
-2282
lines changed

11 files changed

+20757
-2282
lines changed

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

Lines changed: 1537 additions & 43 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/ghes-2.22.json

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28669,12 +28669,13 @@
2866928669
},
2867028670
{
2867128671
"name": "run_id",
28672+
"description": "The id of the workflow run",
2867228673
"in": "path",
2867328674
"required": true,
2867428675
"schema": {
2867528676
"type": "integer"
2867628677
},
28677-
"descriptionHTML": ""
28678+
"descriptionHTML": "<p>The id of the workflow run</p>"
2867828679
}
2867928680
],
2868028681
"x-codeSamples": [
@@ -28748,12 +28749,13 @@
2874828749
},
2874928750
{
2875028751
"name": "run_id",
28752+
"description": "The id of the workflow run",
2875128753
"in": "path",
2875228754
"required": true,
2875328755
"schema": {
2875428756
"type": "integer"
2875528757
},
28756-
"descriptionHTML": ""
28758+
"descriptionHTML": "<p>The id of the workflow run</p>"
2875728759
}
2875828760
],
2875928761
"x-codeSamples": [
@@ -28826,12 +28828,13 @@
2882628828
},
2882728829
{
2882828830
"name": "run_id",
28831+
"description": "The id of the workflow run",
2882928832
"in": "path",
2883028833
"required": true,
2883128834
"schema": {
2883228835
"type": "integer"
2883328836
},
28834-
"descriptionHTML": ""
28837+
"descriptionHTML": "<p>The id of the workflow run</p>"
2883528838
},
2883628839
{
2883728840
"name": "per_page",
@@ -28925,12 +28928,13 @@
2892528928
},
2892628929
{
2892728930
"name": "run_id",
28931+
"description": "The id of the workflow run",
2892828932
"in": "path",
2892928933
"required": true,
2893028934
"schema": {
2893128935
"type": "integer"
2893228936
},
28933-
"descriptionHTML": ""
28937+
"descriptionHTML": "<p>The id of the workflow run</p>"
2893428938
}
2893528939
],
2893628940
"x-codeSamples": [
@@ -29003,12 +29007,13 @@
2900329007
},
2900429008
{
2900529009
"name": "run_id",
29010+
"description": "The id of the workflow run",
2900629011
"in": "path",
2900729012
"required": true,
2900829013
"schema": {
2900929014
"type": "integer"
2901029015
},
29011-
"descriptionHTML": ""
29016+
"descriptionHTML": "<p>The id of the workflow run</p>"
2901229017
},
2901329018
{
2901429019
"name": "filter",
@@ -29117,12 +29122,13 @@
2911729122
},
2911829123
{
2911929124
"name": "run_id",
29125+
"description": "The id of the workflow run",
2912029126
"in": "path",
2912129127
"required": true,
2912229128
"schema": {
2912329129
"type": "integer"
2912429130
},
29125-
"descriptionHTML": ""
29131+
"descriptionHTML": "<p>The id of the workflow run</p>"
2912629132
}
2912729133
],
2912829134
"x-codeSamples": [
@@ -29195,12 +29201,13 @@
2919529201
},
2919629202
{
2919729203
"name": "run_id",
29204+
"description": "The id of the workflow run",
2919829205
"in": "path",
2919929206
"required": true,
2920029207
"schema": {
2920129208
"type": "integer"
2920229209
},
29203-
"descriptionHTML": ""
29210+
"descriptionHTML": "<p>The id of the workflow run</p>"
2920429211
}
2920529212
],
2920629213
"x-codeSamples": [
@@ -29273,12 +29280,13 @@
2927329280
},
2927429281
{
2927529282
"name": "run_id",
29283+
"description": "The id of the workflow run",
2927629284
"in": "path",
2927729285
"required": true,
2927829286
"schema": {
2927929287
"type": "integer"
2928029288
},
29281-
"descriptionHTML": ""
29289+
"descriptionHTML": "<p>The id of the workflow run</p>"
2928229290
}
2928329291
],
2928429292
"x-codeSamples": [

lib/rest/static/decorated/ghes-3.0.json

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33009,12 +33009,13 @@
3300933009
},
3301033010
{
3301133011
"name": "run_id",
33012+
"description": "The id of the workflow run",
3301233013
"in": "path",
3301333014
"required": true,
3301433015
"schema": {
3301533016
"type": "integer"
3301633017
},
33017-
"descriptionHTML": ""
33018+
"descriptionHTML": "<p>The id of the workflow run</p>"
3301833019
}
3301933020
],
3302033021
"x-codeSamples": [
@@ -33088,12 +33089,13 @@
3308833089
},
3308933090
{
3309033091
"name": "run_id",
33092+
"description": "The id of the workflow run",
3309133093
"in": "path",
3309233094
"required": true,
3309333095
"schema": {
3309433096
"type": "integer"
3309533097
},
33096-
"descriptionHTML": ""
33098+
"descriptionHTML": "<p>The id of the workflow run</p>"
3309733099
}
3309833100
],
3309933101
"x-codeSamples": [
@@ -33166,12 +33168,13 @@
3316633168
},
3316733169
{
3316833170
"name": "run_id",
33171+
"description": "The id of the workflow run",
3316933172
"in": "path",
3317033173
"required": true,
3317133174
"schema": {
3317233175
"type": "integer"
3317333176
},
33174-
"descriptionHTML": ""
33177+
"descriptionHTML": "<p>The id of the workflow run</p>"
3317533178
},
3317633179
{
3317733180
"name": "per_page",
@@ -33265,12 +33268,13 @@
3326533268
},
3326633269
{
3326733270
"name": "run_id",
33271+
"description": "The id of the workflow run",
3326833272
"in": "path",
3326933273
"required": true,
3327033274
"schema": {
3327133275
"type": "integer"
3327233276
},
33273-
"descriptionHTML": ""
33277+
"descriptionHTML": "<p>The id of the workflow run</p>"
3327433278
}
3327533279
],
3327633280
"x-codeSamples": [
@@ -33343,12 +33347,13 @@
3334333347
},
3334433348
{
3334533349
"name": "run_id",
33350+
"description": "The id of the workflow run",
3334633351
"in": "path",
3334733352
"required": true,
3334833353
"schema": {
3334933354
"type": "integer"
3335033355
},
33351-
"descriptionHTML": ""
33356+
"descriptionHTML": "<p>The id of the workflow run</p>"
3335233357
},
3335333358
{
3335433359
"name": "filter",
@@ -33457,12 +33462,13 @@
3345733462
},
3345833463
{
3345933464
"name": "run_id",
33465+
"description": "The id of the workflow run",
3346033466
"in": "path",
3346133467
"required": true,
3346233468
"schema": {
3346333469
"type": "integer"
3346433470
},
33465-
"descriptionHTML": ""
33471+
"descriptionHTML": "<p>The id of the workflow run</p>"
3346633472
}
3346733473
],
3346833474
"x-codeSamples": [
@@ -33535,12 +33541,13 @@
3353533541
},
3353633542
{
3353733543
"name": "run_id",
33544+
"description": "The id of the workflow run",
3353833545
"in": "path",
3353933546
"required": true,
3354033547
"schema": {
3354133548
"type": "integer"
3354233549
},
33543-
"descriptionHTML": ""
33550+
"descriptionHTML": "<p>The id of the workflow run</p>"
3354433551
}
3354533552
],
3354633553
"x-codeSamples": [
@@ -33613,12 +33620,13 @@
3361333620
},
3361433621
{
3361533622
"name": "run_id",
33623+
"description": "The id of the workflow run",
3361633624
"in": "path",
3361733625
"required": true,
3361833626
"schema": {
3361933627
"type": "integer"
3362033628
},
33621-
"descriptionHTML": ""
33629+
"descriptionHTML": "<p>The id of the workflow run</p>"
3362233630
}
3362333631
],
3362433632
"x-codeSamples": [

0 commit comments

Comments
 (0)