Skip to content

Commit 8e49a7c

Browse files
Update OpenAPI 3.1 Descriptions
1 parent 77b3ef4 commit 8e49a7c

28 files changed

+883
-566
lines changed

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

Lines changed: 10 additions & 7 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",
@@ -22665,7 +22667,7 @@
2266522667
},
2266622668
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
2266722669
"get": {
22668-
"summary": "List workflow runs",
22670+
"summary": "List workflow runs for a workflow",
2266922671
"description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
2267022672
"tags": [
2267122673
"actions"
@@ -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: 10 additions & 4 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:
@@ -16174,7 +16178,7 @@ paths:
1617416178
subcategory: workflows
1617516179
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs":
1617616180
get:
16177-
summary: List workflow runs
16181+
summary: List workflow runs for a workflow
1617816182
description: |-
1617916183
List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
1618016184

@@ -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:

0 commit comments

Comments
 (0)