Skip to content

Commit 67ef02b

Browse files
Update OpenAPI 3.0 Descriptions
1 parent 77b3ef4 commit 67ef02b

28 files changed

+895
-572
lines changed

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

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14230,8 +14230,9 @@
1423014230
},
1423114231
"use_squash_pr_title_as_default": {
1423214232
"type": "boolean",
14233-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
14234-
"default": false
14233+
"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.",
14234+
"default": false,
14235+
"deprecated": true
1423514236
},
1423614237
"squash_merge_commit_title": {
1423714238
"type": "string",
@@ -19081,8 +19082,9 @@
1908119082
},
1908219083
"use_squash_pr_title_as_default": {
1908319084
"type": "boolean",
19084-
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
19085-
"default": false
19085+
"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.",
19086+
"default": false,
19087+
"deprecated": true
1908619088
},
1908719089
"squash_merge_commit_title": {
1908819090
"type": "string",
@@ -22539,7 +22541,7 @@
2253922541
},
2254022542
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
2254122543
"get": {
22542-
"summary": "List workflow runs",
22544+
"summary": "List workflow runs for a workflow",
2254322545
"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.",
2254422546
"tags": [
2254522547
"actions"
@@ -60594,8 +60596,9 @@
6059460596
},
6059560597
"use_squash_pr_title_as_default": {
6059660598
"type": "boolean",
60597-
"description": "Whether a squash merge commit can use the pull request title as default.",
60598-
"default": false
60599+
"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.",
60600+
"default": false,
60601+
"deprecated": true
6059960602
},
6060060603
"squash_merge_commit_title": {
6060160604
"type": "string",
@@ -65556,8 +65559,9 @@
6555665559
},
6555765560
"use_squash_pr_title_as_default": {
6555865561
"type": "boolean",
65559-
"description": "Whether a squash merge commit can use the pull request title as default.",
65560-
"default": false
65562+
"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.",
65563+
"default": false,
65564+
"deprecated": true
6556165565
},
6556265566
"squash_merge_commit_title": {
6556365567
"type": "string",

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10244,8 +10244,10 @@ paths:
1024410244
use_squash_pr_title_as_default:
1024510245
type: boolean
1024610246
description: Either `true` to allow squash-merge commits to use
10247-
pull request title, or `false` to use commit message.
10247+
pull request title, or `false` to use commit message. **This property
10248+
has been deprecated. Please use `squash_merge_commit_title` instead.
1024810249
default: false
10250+
deprecated: true
1024910251
squash_merge_commit_title:
1025010252
type: string
1025110253
enum:
@@ -13663,8 +13665,10 @@ paths:
1366313665
use_squash_pr_title_as_default:
1366413666
type: boolean
1366513667
description: Either `true` to allow squash-merge commits to use
13666-
pull request title, or `false` to use commit message.
13668+
pull request title, or `false` to use commit message. **This property
13669+
has been deprecated. Please use `squash_merge_commit_title` instead.
1366713670
default: false
13671+
deprecated: true
1366813672
squash_merge_commit_title:
1366913673
type: string
1367013674
enum:
@@ -16114,7 +16118,7 @@ paths:
1611416118
subcategory: workflows
1611516119
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs":
1611616120
get:
16117-
summary: List workflow runs
16121+
summary: List workflow runs for a workflow
1611816122
description: |-
1611916123
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).
1612016124

@@ -43673,8 +43677,10 @@ components:
4367343677
use_squash_pr_title_as_default:
4367443678
type: boolean
4367543679
description: Whether a squash merge commit can use the pull request title
43676-
as default.
43680+
as default. **This property has been deprecated. Please use `squash_merge_commit_title`
43681+
instead.
4367743682
default: false
43683+
deprecated: true
4367843684
squash_merge_commit_title:
4367943685
type: string
4368043686
enum:
@@ -47568,8 +47574,10 @@ components:
4756847574
use_squash_pr_title_as_default:
4756947575
type: boolean
4757047576
description: Whether a squash merge commit can use the pull request title
47571-
as default.
47577+
as default. **This property has been deprecated. Please use `squash_merge_commit_title`
47578+
instead.
4757247579
default: false
47580+
deprecated: true
4757347581
squash_merge_commit_title:
4757447582
type: string
4757547583
enum:

0 commit comments

Comments
 (0)