Skip to content

Commit 30c45e9

Browse files
timrogerstimrogers
authored
Merge pull request #1512 from github/openapi-update-60eba05f3fc020519326138465f9ac16cabbc1508b215ddf2c13920bfecda0c2
Update OpenAPI 3.1 Descriptions
2 parents 7aa877f + 8e49a7c commit 30c45e9

28 files changed

+855
-538
lines changed

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14300,8 +14300,9 @@
1430014300
},
1430114301
"use_squash_pr_title_as_default": {
1430214302
"type": "boolean",
14303-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
14304-
"default": false
14303+
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
14304+
"default": false,
14305+
"deprecated": true
1430514306
},
1430614307
"squash_merge_commit_title": {
1430714308
"type": "string",
@@ -19195,8 +19196,9 @@
1919519196
},
1919619197
"use_squash_pr_title_as_default": {
1919719198
"type": "boolean",
19198-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
19199-
"default": false
19199+
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
19200+
"default": false,
19201+
"deprecated": true
1920019202
},
1920119203
"squash_merge_commit_title": {
1920219204
"type": "string",
@@ -61237,8 +61239,9 @@
6123761239
},
6123861240
"use_squash_pr_title_as_default": {
6123961241
"type": "boolean",
61240-
"description": "Whether a squash merge commit can use the pull request title as default.",
61241-
"default": false
61242+
"description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
61243+
"default": false,
61244+
"deprecated": true
6124261245
},
6124361246
"squash_merge_commit_title": {
6124461247
"type": "string",

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

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10277,8 +10277,10 @@ paths:
1027710277
use_squash_pr_title_as_default:
1027810278
type: boolean
1027910279
description: Either `true` to allow squash-merge commits to use
10280-
pull request title, or `false` to use commit message.
10280+
pull request title, or `false` to use commit message. **This property
10281+
has been deprecated. Please use `squash_merge_commit_title` instead.
1028110282
default: false
10283+
deprecated: true
1028210284
squash_merge_commit_title:
1028310285
type: string
1028410286
enum:
@@ -13717,8 +13719,10 @@ paths:
1371713719
use_squash_pr_title_as_default:
1371813720
type: boolean
1371913721
description: Either `true` to allow squash-merge commits to use
13720-
pull request title, or `false` to use commit message.
13722+
pull request title, or `false` to use commit message. **This property
13723+
has been deprecated. Please use `squash_merge_commit_title` instead.
1372113724
default: false
13725+
deprecated: true
1372213726
squash_merge_commit_title:
1372313727
type: string
1372413728
enum:
@@ -43952,8 +43956,10 @@ components:
4395243956
use_squash_pr_title_as_default:
4395343957
type: boolean
4395443958
description: Whether a squash merge commit can use the pull request title
43955-
as default.
43959+
as default. **This property has been deprecated. Please use `squash_merge_commit_title`
43960+
instead.
4395643961
default: false
43962+
deprecated: true
4395743963
squash_merge_commit_title:
4395843964
type: string
4395943965
enum:

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

Lines changed: 375 additions & 250 deletions
Large diffs are not rendered by default.

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

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2698,8 +2698,10 @@ paths:
26982698
use_squash_pr_title_as_default:
26992699
type: boolean
27002700
description: Whether a squash merge commit can use the pull
2701-
request title as default.
2701+
request title as default. **This property has been deprecated.
2702+
Please use `squash_merge_commit_title` instead.
27022703
default: false
2704+
deprecated: true
27032705
squash_merge_commit_title:
27042706
type: string
27052707
enum:
@@ -24342,8 +24344,10 @@ paths:
2434224344
use_squash_pr_title_as_default:
2434324345
type: boolean
2434424346
description: Either `true` to allow squash-merge commits to use
24345-
pull request title, or `false` to use commit message.
24347+
pull request title, or `false` to use commit message. **This property
24348+
has been deprecated. Please use `squash_merge_commit_title` instead.
2434624349
default: false
24350+
deprecated: true
2434724351
squash_merge_commit_title:
2434824352
type: string
2434924353
enum:
@@ -31165,8 +31169,10 @@ paths:
3116531169
use_squash_pr_title_as_default:
3116631170
type: boolean
3116731171
description: Either `true` to allow squash-merge commits to use
31168-
pull request title, or `false` to use commit message.
31172+
pull request title, or `false` to use commit message. **This property
31173+
has been deprecated. Please use `squash_merge_commit_title` instead.
3116931174
default: false
31175+
deprecated: true
3117031176
squash_merge_commit_title:
3117131177
type: string
3117231178
enum:

‎descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99767,8 +99767,9 @@
9976799767
},
9976899768
"use_squash_pr_title_as_default": {
9976999769
"type": "boolean",
99770-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
99771-
"default": false
99770+
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
99771+
"default": false,
99772+
"deprecated": true
9977299773
},
9977399774
"squash_merge_commit_title": {
9977499775
"type": "string",
@@ -129884,8 +129885,9 @@
129884129885
},
129885129886
"use_squash_pr_title_as_default": {
129886129887
"type": "boolean",
129887-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
129888-
"default": false
129888+
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
129889+
"default": false,
129890+
"deprecated": true
129889129891
},
129890129892
"squash_merge_commit_title": {
129891129893
"type": "string",

‎descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20023,8 +20023,10 @@ paths:
2002320023
use_squash_pr_title_as_default:
2002420024
type: boolean
2002520025
description: Either `true` to allow squash-merge commits to use
20026-
pull request title, or `false` to use commit message.
20026+
pull request title, or `false` to use commit message. **This property
20027+
has been deprecated. Please use `squash_merge_commit_title` instead.
2002720028
default: false
20029+
deprecated: true
2002820030
squash_merge_commit_title:
2002920031
type: string
2003020032
enum:
@@ -26819,8 +26821,10 @@ paths:
2681926821
use_squash_pr_title_as_default:
2682026822
type: boolean
2682126823
description: Either `true` to allow squash-merge commits to use
26822-
pull request title, or `false` to use commit message.
26824+
pull request title, or `false` to use commit message. **This property
26825+
has been deprecated. Please use `squash_merge_commit_title` instead.
2682326826
default: false
26827+
deprecated: true
2682426828
squash_merge_commit_title:
2682526829
type: string
2682626830
enum:

‎descriptions-next/ghes-3.2/ghes-3.2.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13637,8 +13637,9 @@
1363713637
},
1363813638
"use_squash_pr_title_as_default": {
1363913639
"type": "boolean",
13640-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
13641-
"default": false
13640+
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
13641+
"default": false,
13642+
"deprecated": true
1364213643
},
1364313644
"squash_merge_commit_title": {
1364413645
"type": "string",
@@ -18016,8 +18017,9 @@
1801618017
},
1801718018
"use_squash_pr_title_as_default": {
1801818019
"type": "boolean",
18019-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
18020-
"default": false
18020+
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
18021+
"default": false,
18022+
"deprecated": true
1802118023
},
1802218024
"squash_merge_commit_title": {
1802318025
"type": "string",

‎descriptions-next/ghes-3.2/ghes-3.2.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9786,8 +9786,10 @@ paths:
97869786
use_squash_pr_title_as_default:
97879787
type: boolean
97889788
description: Either `true` to allow squash-merge commits to use
9789-
pull request title, or `false` to use commit message.
9789+
pull request title, or `false` to use commit message. **This property
9790+
has been deprecated. Please use `squash_merge_commit_title` instead.
97909791
default: false
9792+
deprecated: true
97919793
squash_merge_commit_title:
97929794
type: string
97939795
enum:
@@ -13033,8 +13035,10 @@ paths:
1303313035
use_squash_pr_title_as_default:
1303413036
type: boolean
1303513037
description: Either `true` to allow squash-merge commits to use
13036-
pull request title, or `false` to use commit message.
13038+
pull request title, or `false` to use commit message. **This property
13039+
has been deprecated. Please use `squash_merge_commit_title` instead.
1303713040
default: false
13041+
deprecated: true
1303813042
squash_merge_commit_title:
1303913043
type: string
1304013044
enum:

‎descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100528,8 +100528,9 @@
100528100528
},
100529100529
"use_squash_pr_title_as_default": {
100530100530
"type": "boolean",
100531-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
100532-
"default": false
100531+
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
100532+
"default": false,
100533+
"deprecated": true
100533100534
},
100534100535
"squash_merge_commit_title": {
100535100536
"type": "string",
@@ -131128,8 +131129,9 @@
131128131129
},
131129131130
"use_squash_pr_title_as_default": {
131130131131
"type": "boolean",
131131-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
131132-
"default": false
131132+
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
131133+
"default": false,
131134+
"deprecated": true
131133131135
},
131134131136
"squash_merge_commit_title": {
131135131137
"type": "string",

0 commit comments

Comments
 (0)