Skip to content

Commit cac8622

Browse files
beccobecco
authored
Merge pull request #1471 from github/openapi-update-cc534c94cc4f615399d7e9968c198b468e8d93dc1c76568deb0dc1121f32ea28
Update OpenAPI 3.0 Descriptions
2 parents 486fbbc + 62bb1a6 commit cac8622

28 files changed

Lines changed: 22671 additions & 2301 deletions

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

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

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

Lines changed: 384 additions & 9 deletions
Large diffs are not rendered by default.

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

Lines changed: 8627 additions & 0 deletions
Large diffs are not rendered by default.

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

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

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

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85671,6 +85671,40 @@
8567185671
"type": "boolean",
8567285672
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
8567385673
"default": false
85674+
},
85675+
"squash_merge_commit_title": {
85676+
"type": "string",
85677+
"enum": [
85678+
"PR_TITLE",
85679+
"COMMIT_OR_PR_TITLE"
85680+
],
85681+
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)."
85682+
},
85683+
"squash_merge_commit_message": {
85684+
"type": "string",
85685+
"enum": [
85686+
"PR_BODY",
85687+
"COMMIT_MESSAGES",
85688+
"BLANK"
85689+
],
85690+
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
85691+
},
85692+
"merge_commit_title": {
85693+
"type": "string",
85694+
"enum": [
85695+
"PR_TITLE",
85696+
"MERGE_MESSAGE"
85697+
],
85698+
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
85699+
},
85700+
"merge_commit_message": {
85701+
"type": "string",
85702+
"enum": [
85703+
"PR_BODY",
85704+
"PR_TITLE",
85705+
"BLANK"
85706+
],
85707+
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
8567485708
}
8567585709
},
8567685710
"required": [
@@ -111143,6 +111177,40 @@
111143111177
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
111144111178
"default": false
111145111179
},
111180+
"squash_merge_commit_title": {
111181+
"type": "string",
111182+
"enum": [
111183+
"PR_TITLE",
111184+
"COMMIT_OR_PR_TITLE"
111185+
],
111186+
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)."
111187+
},
111188+
"squash_merge_commit_message": {
111189+
"type": "string",
111190+
"enum": [
111191+
"PR_BODY",
111192+
"COMMIT_MESSAGES",
111193+
"BLANK"
111194+
],
111195+
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
111196+
},
111197+
"merge_commit_title": {
111198+
"type": "string",
111199+
"enum": [
111200+
"PR_TITLE",
111201+
"MERGE_MESSAGE"
111202+
],
111203+
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
111204+
},
111205+
"merge_commit_message": {
111206+
"type": "string",
111207+
"enum": [
111208+
"PR_BODY",
111209+
"PR_TITLE",
111210+
"BLANK"
111211+
],
111212+
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
111213+
},
111146111214
"archived": {
111147111215
"type": "boolean",
111148111216
"description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -128756,10 +128824,17 @@
128756128824
"content": {
128757128825
"application/json": {
128758128826
"schema": {
128827+
"title": "Empty Object",
128828+
"description": "An object without any properties.",
128759128829
"type": "object",
128760128830
"properties": {
128761128831
},
128762128832
"additionalProperties": false
128833+
},
128834+
"examples": {
128835+
"default": {
128836+
"value": null
128837+
}
128763128838
}
128764128839
}
128765128840
}
@@ -129901,6 +129976,17 @@
129901129976
"state",
129902129977
"comment"
129903129978
]
129979+
},
129980+
"examples": {
129981+
"default": {
129982+
"value": {
129983+
"environment_ids": [
129984+
161171787
129985+
],
129986+
"state": "approved",
129987+
"comment": "Ship it!"
129988+
}
129989+
}
129904129990
}
129905129991
}
129906129992
}
@@ -130490,6 +130576,11 @@
130490130576
"schema": {
130491130577
"type": "object",
130492130578
"nullable": true
130579+
},
130580+
"examples": {
130581+
"default": {
130582+
"value": null
130583+
}
130493130584
}
130494130585
}
130495130586
}
@@ -130500,10 +130591,17 @@
130500130591
"content": {
130501130592
"application/json": {
130502130593
"schema": {
130594+
"title": "Empty Object",
130595+
"description": "An object without any properties.",
130503130596
"type": "object",
130504130597
"properties": {
130505130598
},
130506130599
"additionalProperties": false
130600+
},
130601+
"examples": {
130602+
"default": {
130603+
"value": null
130604+
}
130507130605
}
130508130606
}
130509130607
}
@@ -130911,10 +131009,17 @@
130911131009
"content": {
130912131010
"application/json": {
130913131011
"schema": {
131012+
"title": "Empty Object",
131013+
"description": "An object without any properties.",
130914131014
"type": "object",
130915131015
"properties": {
130916131016
},
130917131017
"additionalProperties": false
131018+
},
131019+
"examples": {
131020+
"default": {
131021+
"value": null
131022+
}
130918131023
}
130919131024
}
130920131025
}
@@ -367095,6 +367200,40 @@
367095367200
"type": "boolean",
367096367201
"example": false
367097367202
},
367203+
"squash_merge_commit_title": {
367204+
"type": "string",
367205+
"enum": [
367206+
"PR_TITLE",
367207+
"COMMIT_OR_PR_TITLE"
367208+
],
367209+
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)."
367210+
},
367211+
"squash_merge_commit_message": {
367212+
"type": "string",
367213+
"enum": [
367214+
"PR_BODY",
367215+
"COMMIT_MESSAGES",
367216+
"BLANK"
367217+
],
367218+
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
367219+
},
367220+
"merge_commit_title": {
367221+
"type": "string",
367222+
"enum": [
367223+
"PR_TITLE",
367224+
"MERGE_MESSAGE"
367225+
],
367226+
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
367227+
},
367228+
"merge_commit_message": {
367229+
"type": "string",
367230+
"enum": [
367231+
"PR_BODY",
367232+
"PR_TITLE",
367233+
"BLANK"
367234+
],
367235+
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
367236+
},
367098367237
"has_downloads": {
367099367238
"description": "Whether downloads are enabled.",
367100367239
"default": true,

0 commit comments

Comments
 (0)