Skip to content

Commit ef7723e

Browse files
beccobecco
authored
Merge pull request #1472 from github/openapi-update-5168f516da1396b58e3c87b2910d33e3a6cd4e743996c86c69622d98c5553832
Update OpenAPI 3.1 Descriptions
2 parents cac8622 + 85a726c commit ef7723e

28 files changed

Lines changed: 22399 additions & 2261 deletions

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

Lines changed: 260 additions & 12 deletions
Large diffs are not rendered by default.

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

Lines changed: 300 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10229,6 +10229,50 @@ paths:
1022910229
description: Either `true` to allow squash-merge commits to use
1023010230
pull request title, or `false` to use commit message.
1023110231
default: false
10232+
squash_merge_commit_title:
10233+
type: string
10234+
enum:
10235+
- PR_TITLE
10236+
- COMMIT_OR_PR_TITLE
10237+
description: |-
10238+
The default value for a squash merge commit title:
10239+
10240+
- `PR_TITLE` - default to the pull request's title.
10241+
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
10242+
squash_merge_commit_message:
10243+
type: string
10244+
enum:
10245+
- PR_BODY
10246+
- COMMIT_MESSAGES
10247+
- BLANK
10248+
description: |-
10249+
The default value for a squash merge commit message:
10250+
10251+
- `PR_BODY` - default to the pull request's body.
10252+
- `COMMIT_MESSAGES` - default to the branch's commit messages.
10253+
- `BLANK` - default to a blank commit message.
10254+
merge_commit_title:
10255+
type: string
10256+
enum:
10257+
- PR_TITLE
10258+
- MERGE_MESSAGE
10259+
description: |-
10260+
The default value for a merge commit title.
10261+
10262+
- `PR_TITLE` - default to the pull request's title.
10263+
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
10264+
merge_commit_message:
10265+
type: string
10266+
enum:
10267+
- PR_BODY
10268+
- PR_TITLE
10269+
- BLANK
10270+
description: |-
10271+
The default value for a merge commit message.
10272+
10273+
- `PR_TITLE` - default to the pull request's title.
10274+
- `PR_BODY` - default to the pull request's body.
10275+
- `BLANK` - default to a blank commit message.
1023210276
required:
1023310277
- name
1023410278
examples:
@@ -13591,6 +13635,50 @@ paths:
1359113635
description: Either `true` to allow squash-merge commits to use
1359213636
pull request title, or `false` to use commit message.
1359313637
default: false
13638+
squash_merge_commit_title:
13639+
type: string
13640+
enum:
13641+
- PR_TITLE
13642+
- COMMIT_OR_PR_TITLE
13643+
description: |-
13644+
The default value for a squash merge commit title:
13645+
13646+
- `PR_TITLE` - default to the pull request's title.
13647+
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
13648+
squash_merge_commit_message:
13649+
type: string
13650+
enum:
13651+
- PR_BODY
13652+
- COMMIT_MESSAGES
13653+
- BLANK
13654+
description: |-
13655+
The default value for a squash merge commit message:
13656+
13657+
- `PR_BODY` - default to the pull request's body.
13658+
- `COMMIT_MESSAGES` - default to the branch's commit messages.
13659+
- `BLANK` - default to a blank commit message.
13660+
merge_commit_title:
13661+
type: string
13662+
enum:
13663+
- PR_TITLE
13664+
- MERGE_MESSAGE
13665+
description: |-
13666+
The default value for a merge commit title.
13667+
13668+
- `PR_TITLE` - default to the pull request's title.
13669+
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
13670+
merge_commit_message:
13671+
type: string
13672+
enum:
13673+
- PR_BODY
13674+
- PR_TITLE
13675+
- BLANK
13676+
description: |-
13677+
The default value for a merge commit message.
13678+
13679+
- `PR_TITLE` - default to the pull request's title.
13680+
- `PR_BODY` - default to the pull request's body.
13681+
- `BLANK` - default to a blank commit message.
1359413682
archived:
1359513683
type: boolean
1359613684
description: "`true` to archive this repository. **Note**: You cannot
@@ -14042,6 +14130,9 @@ paths:
1404214130
type: boolean
1404314131
default: false
1404414132
description: Whether to enable debug logging for the re-run.
14133+
examples:
14134+
default:
14135+
value:
1404514136
responses:
1404614137
'201':
1404714138
description: Response
@@ -15181,9 +15272,10 @@ paths:
1518115272
content:
1518215273
application/json:
1518315274
schema:
15184-
type: object
15185-
properties: {}
15186-
additionalProperties: false
15275+
"$ref": "#/components/schemas/empty-object"
15276+
examples:
15277+
default:
15278+
value:
1518715279
'409':
1518815280
"$ref": "#/components/responses/conflict"
1518915281
x-github:
@@ -15394,6 +15486,13 @@ paths:
1539415486
- environment_ids
1539515487
- state
1539615488
- comment
15489+
examples:
15490+
default:
15491+
value:
15492+
environment_ids:
15493+
- 161171787
15494+
state: approved
15495+
comment: Ship it!
1539715496
responses:
1539815497
'200':
1539915498
description: Response
@@ -15440,15 +15539,19 @@ paths:
1544015539
type: boolean
1544115540
default: false
1544215541
description: Whether to enable debug logging for the re-run.
15542+
examples:
15543+
default:
15544+
value:
1544315545
responses:
1544415546
'201':
1544515547
description: Response
1544615548
content:
1544715549
application/json:
1544815550
schema:
15449-
type: object
15450-
properties: {}
15451-
additionalProperties: false
15551+
"$ref": "#/components/schemas/empty-object"
15552+
examples:
15553+
default:
15554+
value:
1545215555
x-github:
1545315556
githubCloudOnly: false
1545415557
enabledForGitHubApps: false
@@ -15483,6 +15586,9 @@ paths:
1548315586
type: boolean
1548415587
default: false
1548515588
description: Whether to enable debug logging for the re-run.
15589+
examples:
15590+
default:
15591+
value:
1548615592
responses:
1548715593
'201':
1548815594
description: Response
@@ -15756,9 +15862,10 @@ paths:
1575615862
content:
1575715863
application/json:
1575815864
schema:
15759-
type: object
15760-
properties: {}
15761-
additionalProperties: false
15865+
"$ref": "#/components/schemas/empty-object"
15866+
examples:
15867+
default:
15868+
value:
1576215869
'204':
1576315870
description: Response when updating a secret
1576415871
x-github:
@@ -40004,6 +40111,50 @@ paths:
4000440111
type: boolean
4000540112
examples:
4000640113
- false
40114+
squash_merge_commit_title:
40115+
type: string
40116+
enum:
40117+
- PR_TITLE
40118+
- COMMIT_OR_PR_TITLE
40119+
description: |-
40120+
The default value for a squash merge commit title:
40121+
40122+
- `PR_TITLE` - default to the pull request's title.
40123+
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
40124+
squash_merge_commit_message:
40125+
type: string
40126+
enum:
40127+
- PR_BODY
40128+
- COMMIT_MESSAGES
40129+
- BLANK
40130+
description: |-
40131+
The default value for a squash merge commit message:
40132+
40133+
- `PR_BODY` - default to the pull request's body.
40134+
- `COMMIT_MESSAGES` - default to the branch's commit messages.
40135+
- `BLANK` - default to a blank commit message.
40136+
merge_commit_title:
40137+
type: string
40138+
enum:
40139+
- PR_TITLE
40140+
- MERGE_MESSAGE
40141+
description: |-
40142+
The default value for a merge commit title.
40143+
40144+
- `PR_TITLE` - default to the pull request's title.
40145+
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
40146+
merge_commit_message:
40147+
type: string
40148+
enum:
40149+
- PR_BODY
40150+
- PR_TITLE
40151+
- BLANK
40152+
description: |-
40153+
The default value for a merge commit message.
40154+
40155+
- `PR_TITLE` - default to the pull request's title.
40156+
- `PR_BODY` - default to the pull request's body.
40157+
- `BLANK` - default to a blank commit message.
4000740158
has_downloads:
4000840159
description: Whether downloads are enabled.
4000940160
default: true
@@ -43308,6 +43459,50 @@ components:
4330843459
type: boolean
4330943460
use_squash_pr_title_as_default:
4331043461
type: boolean
43462+
squash_merge_commit_title:
43463+
type: string
43464+
enum:
43465+
- PR_TITLE
43466+
- COMMIT_OR_PR_TITLE
43467+
description: |-
43468+
The default value for a squash merge commit title:
43469+
43470+
- `PR_TITLE` - default to the pull request's title.
43471+
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
43472+
squash_merge_commit_message:
43473+
type: string
43474+
enum:
43475+
- PR_BODY
43476+
- COMMIT_MESSAGES
43477+
- BLANK
43478+
description: |-
43479+
The default value for a squash merge commit message:
43480+
43481+
- `PR_BODY` - default to the pull request's body.
43482+
- `COMMIT_MESSAGES` - default to the branch's commit messages.
43483+
- `BLANK` - default to a blank commit message.
43484+
merge_commit_title:
43485+
type: string
43486+
enum:
43487+
- PR_TITLE
43488+
- MERGE_MESSAGE
43489+
description: |-
43490+
The default value for a merge commit title.
43491+
43492+
- `PR_TITLE` - default to the pull request's title.
43493+
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
43494+
merge_commit_message:
43495+
type: string
43496+
enum:
43497+
- PR_BODY
43498+
- PR_TITLE
43499+
- BLANK
43500+
description: |-
43501+
The default value for a merge commit message.
43502+
43503+
- `PR_TITLE` - default to the pull request's title.
43504+
- `PR_BODY` - default to the pull request's body.
43505+
- `BLANK` - default to a blank commit message.
4331143506
allow_merge_commit:
4331243507
type: boolean
4331343508
subscribers_count:
@@ -43347,6 +43542,50 @@ components:
4334743542
description: Whether a squash merge commit can use the pull request title
4334843543
as default.
4334943544
default: false
43545+
squash_merge_commit_title:
43546+
type: string
43547+
enum:
43548+
- PR_TITLE
43549+
- COMMIT_OR_PR_TITLE
43550+
description: |-
43551+
The default value for a squash merge commit title:
43552+
43553+
- `PR_TITLE` - default to the pull request's title.
43554+
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
43555+
squash_merge_commit_message:
43556+
type: string
43557+
enum:
43558+
- PR_BODY
43559+
- COMMIT_MESSAGES
43560+
- BLANK
43561+
description: |-
43562+
The default value for a squash merge commit message:
43563+
43564+
- `PR_BODY` - default to the pull request's body.
43565+
- `COMMIT_MESSAGES` - default to the branch's commit messages.
43566+
- `BLANK` - default to a blank commit message.
43567+
merge_commit_title:
43568+
type: string
43569+
enum:
43570+
- PR_TITLE
43571+
- MERGE_MESSAGE
43572+
description: |-
43573+
The default value for a merge commit title.
43574+
43575+
- `PR_TITLE` - default to the pull request's title.
43576+
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
43577+
merge_commit_message:
43578+
type: string
43579+
enum:
43580+
- PR_BODY
43581+
- PR_TITLE
43582+
- BLANK
43583+
description: |-
43584+
The default value for a merge commit message.
43585+
43586+
- `PR_TITLE` - default to the pull request's title.
43587+
- `PR_BODY` - default to the pull request's body.
43588+
- `BLANK` - default to a blank commit message.
4335043589
allow_merge_commit:
4335143590
description: Whether to allow merge commits for pull requests.
4335243591
default: true
@@ -50538,6 +50777,58 @@ components:
5053850777
type: boolean
5053950778
examples:
5054050779
- false
50780+
squash_merge_commit_title:
50781+
type: string
50782+
enum:
50783+
- PR_TITLE
50784+
- COMMIT_OR_PR_TITLE
50785+
description: |-
50786+
The default value for a squash merge commit title:
50787+
50788+
- `PR_TITLE` - default to the pull request's title.
50789+
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
50790+
examples:
50791+
- PR_TITLE
50792+
squash_merge_commit_message:
50793+
type: string
50794+
enum:
50795+
- PR_BODY
50796+
- COMMIT_MESSAGES
50797+
- BLANK
50798+
description: |-
50799+
The default value for a squash merge commit message:
50800+
50801+
- `PR_BODY` - default to the pull request's body.
50802+
- `COMMIT_MESSAGES` - default to the branch's commit messages.
50803+
- `BLANK` - default to a blank commit message.
50804+
examples:
50805+
- PR_BODY
50806+
merge_commit_title:
50807+
type: string
50808+
enum:
50809+
- PR_TITLE
50810+
- MERGE_MESSAGE
50811+
description: |-
50812+
The default value for a merge commit title.
50813+
50814+
- `PR_TITLE` - default to the pull request's title.
50815+
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
50816+
examples:
50817+
- PR_TITLE
50818+
merge_commit_message:
50819+
type: string
50820+
enum:
50821+
- PR_BODY
50822+
- PR_TITLE
50823+
- BLANK
50824+
description: |-
50825+
The default value for a merge commit message.
50826+
50827+
- `PR_TITLE` - default to the pull request's title.
50828+
- `PR_BODY` - default to the pull request's body.
50829+
- `BLANK` - default to a blank commit message.
50830+
examples:
50831+
- PR_BODY
5054150832
allow_forking:
5054250833
type: boolean
5054350834
examples:

0 commit comments

Comments
 (0)