Skip to content

Commit 287b79c

Browse files
Update OpenAPI Descriptions (#25855)
* Update OpenAPI Descriptions * Add decorated OpenAPI schema files Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
1 parent b925833 commit 287b79c

6 files changed

Lines changed: 77 additions & 118 deletions

File tree

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

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -20009,9 +20009,8 @@
2000920009
"childParamsGroups": []
2001020010
},
2001120011
"bypass_pull_request_allowances": {
20012-
"type": "object or null",
20013-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
20014-
"nullable": true,
20012+
"type": "object",
20013+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
2001520014
"properties": {
2001620015
"users": {
2001720016
"type": "array of strings",
@@ -20041,7 +20040,7 @@
2004120040
"name": "bypass_pull_request_allowances",
2004220041
"in": "body",
2004320042
"rawType": "object",
20044-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
20043+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
2004520044
"childParamsGroups": [
2004620045
{
2004720046
"parentName": "bypass_pull_request_allowances",
@@ -20182,9 +20181,8 @@
2018220181
"childParamsGroups": []
2018320182
},
2018420183
{
20185-
"type": "object or null",
20186-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
20187-
"nullable": true,
20184+
"type": "object",
20185+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
2018820186
"properties": {
2018920187
"users": {
2019020188
"type": "array of strings",
@@ -20214,7 +20212,7 @@
2021420212
"name": "bypass_pull_request_allowances",
2021520213
"in": "body",
2021620214
"rawType": "object",
20217-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
20215+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
2021820216
"childParamsGroups": [
2021920217
{
2022020218
"parentName": "bypass_pull_request_allowances",
@@ -20862,9 +20860,8 @@
2086220860
"childParamsGroups": []
2086320861
},
2086420862
"bypass_pull_request_allowances": {
20865-
"type": "object or null",
20866-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
20867-
"nullable": true,
20863+
"type": "object",
20864+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
2086820865
"properties": {
2086920866
"users": {
2087020867
"type": "array of strings",
@@ -20894,7 +20891,7 @@
2089420891
"name": "bypass_pull_request_allowances",
2089520892
"in": "body",
2089620893
"rawType": "object",
20897-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
20894+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
2089820895
"childParamsGroups": [
2089920896
{
2090020897
"parentName": "bypass_pull_request_allowances",
@@ -21035,9 +21032,8 @@
2103521032
"childParamsGroups": []
2103621033
},
2103721034
{
21038-
"type": "object or null",
21039-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
21040-
"nullable": true,
21035+
"type": "object",
21036+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
2104121037
"properties": {
2104221038
"users": {
2104321039
"type": "array of strings",
@@ -21067,7 +21063,7 @@
2106721063
"name": "bypass_pull_request_allowances",
2106821064
"in": "body",
2106921065
"rawType": "object",
21070-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
21066+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
2107121067
"childParamsGroups": [
2107221068
{
2107321069
"parentName": "bypass_pull_request_allowances",
@@ -21783,9 +21779,8 @@
2178321779
"childParamsGroups": []
2178421780
},
2178521781
"bypass_pull_request_allowances": {
21786-
"type": "object or null",
21787-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
21788-
"nullable": true,
21782+
"type": "object",
21783+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
2178921784
"properties": {
2179021785
"users": {
2179121786
"type": "array of strings",
@@ -21815,7 +21810,7 @@
2181521810
"name": "bypass_pull_request_allowances",
2181621811
"in": "body",
2181721812
"rawType": "object",
21818-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
21813+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
2181921814
"childParamsGroups": [
2182021815
{
2182121816
"parentName": "bypass_pull_request_allowances",
@@ -21995,9 +21990,8 @@
2199521990
"childParamsGroups": []
2199621991
},
2199721992
{
21998-
"type": "object or null",
21999-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
22000-
"nullable": true,
21993+
"type": "object",
21994+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
2200121995
"properties": {
2200221996
"users": {
2200321997
"type": "array of strings",
@@ -22027,7 +22021,7 @@
2202722021
"name": "bypass_pull_request_allowances",
2202822022
"in": "body",
2202922023
"rawType": "object",
22030-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
22024+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
2203122025
"childParamsGroups": [
2203222026
{
2203322027
"parentName": "bypass_pull_request_allowances",

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

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18312,9 +18312,8 @@
1831218312
"childParamsGroups": []
1831318313
},
1831418314
"bypass_pull_request_allowances": {
18315-
"type": "object or null",
18316-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
18317-
"nullable": true,
18315+
"type": "object",
18316+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
1831818317
"properties": {
1831918318
"users": {
1832018319
"type": "array of strings",
@@ -18344,7 +18343,7 @@
1834418343
"name": "bypass_pull_request_allowances",
1834518344
"in": "body",
1834618345
"rawType": "object",
18347-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
18346+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
1834818347
"childParamsGroups": [
1834918348
{
1835018349
"parentName": "bypass_pull_request_allowances",
@@ -18485,9 +18484,8 @@
1848518484
"childParamsGroups": []
1848618485
},
1848718486
{
18488-
"type": "object or null",
18489-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
18490-
"nullable": true,
18487+
"type": "object",
18488+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
1849118489
"properties": {
1849218490
"users": {
1849318491
"type": "array of strings",
@@ -18517,7 +18515,7 @@
1851718515
"name": "bypass_pull_request_allowances",
1851818516
"in": "body",
1851918517
"rawType": "object",
18520-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
18518+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
1852118519
"childParamsGroups": [
1852218520
{
1852318521
"parentName": "bypass_pull_request_allowances",
@@ -19165,9 +19163,8 @@
1916519163
"childParamsGroups": []
1916619164
},
1916719165
"bypass_pull_request_allowances": {
19168-
"type": "object or null",
19169-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
19170-
"nullable": true,
19166+
"type": "object",
19167+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
1917119168
"properties": {
1917219169
"users": {
1917319170
"type": "array of strings",
@@ -19197,7 +19194,7 @@
1919719194
"name": "bypass_pull_request_allowances",
1919819195
"in": "body",
1919919196
"rawType": "object",
19200-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
19197+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
1920119198
"childParamsGroups": [
1920219199
{
1920319200
"parentName": "bypass_pull_request_allowances",
@@ -19338,9 +19335,8 @@
1933819335
"childParamsGroups": []
1933919336
},
1934019337
{
19341-
"type": "object or null",
19342-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
19343-
"nullable": true,
19338+
"type": "object",
19339+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
1934419340
"properties": {
1934519341
"users": {
1934619342
"type": "array of strings",
@@ -19370,7 +19366,7 @@
1937019366
"name": "bypass_pull_request_allowances",
1937119367
"in": "body",
1937219368
"rawType": "object",
19373-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
19369+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
1937419370
"childParamsGroups": [
1937519371
{
1937619372
"parentName": "bypass_pull_request_allowances",
@@ -20086,9 +20082,8 @@
2008620082
"childParamsGroups": []
2008720083
},
2008820084
"bypass_pull_request_allowances": {
20089-
"type": "object or null",
20090-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
20091-
"nullable": true,
20085+
"type": "object",
20086+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
2009220087
"properties": {
2009320088
"users": {
2009420089
"type": "array of strings",
@@ -20118,7 +20113,7 @@
2011820113
"name": "bypass_pull_request_allowances",
2011920114
"in": "body",
2012020115
"rawType": "object",
20121-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
20116+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
2012220117
"childParamsGroups": [
2012320118
{
2012420119
"parentName": "bypass_pull_request_allowances",
@@ -20298,9 +20293,8 @@
2029820293
"childParamsGroups": []
2029920294
},
2030020295
{
20301-
"type": "object or null",
20302-
"description": "<p>Allow specific users or teams to bypass pull request requirements. Set to <code>null</code> to disable.</p>",
20303-
"nullable": true,
20296+
"type": "object",
20297+
"description": "<p>Allow specific users or teams to bypass pull request requirements.</p>",
2030420298
"properties": {
2030520299
"users": {
2030620300
"type": "array of strings",
@@ -20330,7 +20324,7 @@
2033020324
"name": "bypass_pull_request_allowances",
2033120325
"in": "body",
2033220326
"rawType": "object",
20333-
"rawDescription": "Allow specific users or teams to bypass pull request requirements. Set to `null` to disable.",
20327+
"rawDescription": "Allow specific users or teams to bypass pull request requirements.",
2033420328
"childParamsGroups": [
2033520329
{
2033620330
"parentName": "bypass_pull_request_allowances",

0 commit comments

Comments
 (0)