Skip to content

Commit 5b5e5f6

Browse files
authored
fix(typescript): exclude_pull_requests parameter for action runs endpoints (#464)
1 parent 5d2de25 commit 5b5e5f6

File tree

8 files changed

+94
-22
lines changed

8 files changed

+94
-22
lines changed

docs/actions/downloadWorkflowRunAttemptLogs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Download workflow run attempt logs
3-
example: octokit.rest.actions.downloadWorkflowRunAttemptLogs({ owner, repo, attempt_num, attempt_number })
3+
example: octokit.rest.actions.downloadWorkflowRunAttemptLogs({ owner, repo, run_id, attempt_number })
44
route: GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs
55
scope: actions
66
type: API method
@@ -17,7 +17,7 @@ GitHub Apps must have the `actions:read` permission to use this endpoint.
1717
octokit.rest.actions.downloadWorkflowRunAttemptLogs({
1818
owner,
1919
repo,
20-
attempt_num,
20+
run_id,
2121
attempt_number,
2222
});
2323
```
@@ -39,9 +39,9 @@ octokit.rest.actions.downloadWorkflowRunAttemptLogs({
3939
<tr><td>repo</td><td>yes</td><td>
4040

4141
</td></tr>
42-
<tr><td>attempt_num</td><td>yes</td><td>
42+
<tr><td>run_id</td><td>yes</td><td>
4343

44-
The attempt number of the workflow run.
44+
The id of the workflow run.
4545

4646
</td></tr>
4747
<tr><td>attempt_number</td><td>yes</td><td>

docs/actions/getWorkflowRun.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ octokit.rest.actions.getWorkflowRun({
3939

4040
The id of the workflow run.
4141

42+
</td></tr>
43+
<tr><td>exclude_pull_requests</td><td>no</td><td>
44+
45+
If `true` pull requests are omitted from the response (empty array).
46+
4247
</td></tr>
4348
</tbody>
4449
</table>

docs/actions/getWorkflowRunAttempt.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ The id of the workflow run.
4848

4949
The attempt number of the workflow run.
5050

51+
</td></tr>
52+
<tr><td>exclude_pull_requests</td><td>no</td><td>
53+
54+
If `true` pull requests are omitted from the response (empty array).
55+
5156
</td></tr>
5257
</tbody>
5358
</table>

docs/actions/listWorkflowRuns.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@ Page number of the results to fetch.
7474
</td></tr>
7575
<tr><td>created</td><td>no</td><td>
7676

77+
</td></tr>
78+
<tr><td>exclude_pull_requests</td><td>no</td><td>
79+
80+
If `true` pull requests are omitted from the response (empty array).
81+
7782
</td></tr>
7883
</tbody>
7984
</table>

docs/actions/listWorkflowRunsForRepo.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,11 @@ Page number of the results to fetch.
6868
</td></tr>
6969
<tr><td>created</td><td>no</td><td>
7070

71+
</td></tr>
72+
<tr><td>exclude_pull_requests</td><td>no</td><td>
73+
74+
If `true` pull requests are omitted from the response (empty array).
75+
7176
</td></tr>
7277
</tbody>
7378
</table>

package-lock.json

Lines changed: 15 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"author": "Gregor Martynus (https://twitter.com/gr2m)",
2525
"license": "MIT",
2626
"dependencies": {
27-
"@octokit/types": "^6.32.0",
27+
"@octokit/types": "^6.33.0",
2828
"deprecation": "^2.3.1"
2929
},
3030
"devDependencies": {

scripts/update-endpoints/generated/endpoints.json

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1467,8 +1467,8 @@
14671467
"deprecated": null
14681468
},
14691469
{
1470-
"name": "attempt_num",
1471-
"description": "The attempt number of the workflow run.",
1470+
"name": "run_id",
1471+
"description": "The id of the workflow run.",
14721472
"in": "PATH",
14731473
"type": "integer",
14741474
"required": true,
@@ -2751,6 +2751,19 @@
27512751
"validation": null,
27522752
"alias": null,
27532753
"deprecated": null
2754+
},
2755+
{
2756+
"name": "exclude_pull_requests",
2757+
"description": "If `true` pull requests are omitted from the response (empty array).",
2758+
"in": "QUERY",
2759+
"type": "boolean",
2760+
"required": false,
2761+
"enum": null,
2762+
"allowNull": false,
2763+
"mapToData": null,
2764+
"validation": null,
2765+
"alias": null,
2766+
"deprecated": null
27542767
}
27552768
],
27562769
"responses": [
@@ -2831,6 +2844,19 @@
28312844
"validation": null,
28322845
"alias": null,
28332846
"deprecated": null
2847+
},
2848+
{
2849+
"name": "exclude_pull_requests",
2850+
"description": "If `true` pull requests are omitted from the response (empty array).",
2851+
"in": "QUERY",
2852+
"type": "boolean",
2853+
"required": false,
2854+
"enum": null,
2855+
"allowNull": false,
2856+
"mapToData": null,
2857+
"validation": null,
2858+
"alias": null,
2859+
"deprecated": null
28342860
}
28352861
],
28362862
"responses": [
@@ -4112,6 +4138,19 @@
41124138
"validation": null,
41134139
"alias": null,
41144140
"deprecated": null
4141+
},
4142+
{
4143+
"name": "exclude_pull_requests",
4144+
"description": "If `true` pull requests are omitted from the response (empty array).",
4145+
"in": "QUERY",
4146+
"type": "boolean",
4147+
"required": false,
4148+
"enum": null,
4149+
"allowNull": false,
4150+
"mapToData": null,
4151+
"validation": null,
4152+
"alias": null,
4153+
"deprecated": null
41154154
}
41164155
],
41174156
"responses": [
@@ -4271,6 +4310,19 @@
42714310
"validation": null,
42724311
"alias": null,
42734312
"deprecated": null
4313+
},
4314+
{
4315+
"name": "exclude_pull_requests",
4316+
"description": "If `true` pull requests are omitted from the response (empty array).",
4317+
"in": "QUERY",
4318+
"type": "boolean",
4319+
"required": false,
4320+
"enum": null,
4321+
"allowNull": false,
4322+
"mapToData": null,
4323+
"validation": null,
4324+
"alias": null,
4325+
"deprecated": null
42744326
}
42754327
],
42764328
"responses": [

0 commit comments

Comments
 (0)