Skip to content

Commit

Permalink
fix(typescript): exclude_pull_requests parameter for action runs en…
Browse files Browse the repository at this point in the history
…dpoints (#464)
  • Loading branch information
octokitbot committed Oct 8, 2021
1 parent 5d2de25 commit 5b5e5f6
Show file tree
Hide file tree
Showing 8 changed files with 94 additions and 22 deletions.
8 changes: 4 additions & 4 deletions docs/actions/downloadWorkflowRunAttemptLogs.md
@@ -1,6 +1,6 @@
---
name: Download workflow run attempt logs
example: octokit.rest.actions.downloadWorkflowRunAttemptLogs({ owner, repo, attempt_num, attempt_number })
example: octokit.rest.actions.downloadWorkflowRunAttemptLogs({ owner, repo, run_id, attempt_number })
route: GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs
scope: actions
type: API method
Expand All @@ -17,7 +17,7 @@ GitHub Apps must have the `actions:read` permission to use this endpoint.
octokit.rest.actions.downloadWorkflowRunAttemptLogs({
owner,
repo,
attempt_num,
run_id,
attempt_number,
});
```
Expand All @@ -39,9 +39,9 @@ octokit.rest.actions.downloadWorkflowRunAttemptLogs({
<tr><td>repo</td><td>yes</td><td>

</td></tr>
<tr><td>attempt_num</td><td>yes</td><td>
<tr><td>run_id</td><td>yes</td><td>

The attempt number of the workflow run.
The id of the workflow run.

</td></tr>
<tr><td>attempt_number</td><td>yes</td><td>
Expand Down
5 changes: 5 additions & 0 deletions docs/actions/getWorkflowRun.md
Expand Up @@ -39,6 +39,11 @@ octokit.rest.actions.getWorkflowRun({

The id of the workflow run.

</td></tr>
<tr><td>exclude_pull_requests</td><td>no</td><td>

If `true` pull requests are omitted from the response (empty array).

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/actions/getWorkflowRunAttempt.md
Expand Up @@ -48,6 +48,11 @@ The id of the workflow run.

The attempt number of the workflow run.

</td></tr>
<tr><td>exclude_pull_requests</td><td>no</td><td>

If `true` pull requests are omitted from the response (empty array).

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/actions/listWorkflowRuns.md
Expand Up @@ -74,6 +74,11 @@ Page number of the results to fetch.
</td></tr>
<tr><td>created</td><td>no</td><td>

</td></tr>
<tr><td>exclude_pull_requests</td><td>no</td><td>

If `true` pull requests are omitted from the response (empty array).

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/actions/listWorkflowRunsForRepo.md
Expand Up @@ -68,6 +68,11 @@ Page number of the results to fetch.
</td></tr>
<tr><td>created</td><td>no</td><td>

</td></tr>
<tr><td>exclude_pull_requests</td><td>no</td><td>

If `true` pull requests are omitted from the response (empty array).

</td></tr>
</tbody>
</table>
Expand Down
30 changes: 15 additions & 15 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -24,7 +24,7 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"dependencies": {
"@octokit/types": "^6.32.0",
"@octokit/types": "^6.33.0",
"deprecation": "^2.3.1"
},
"devDependencies": {
Expand Down
56 changes: 54 additions & 2 deletions scripts/update-endpoints/generated/endpoints.json
Expand Up @@ -1467,8 +1467,8 @@
"deprecated": null
},
{
"name": "attempt_num",
"description": "The attempt number of the workflow run.",
"name": "run_id",
"description": "The id of the workflow run.",
"in": "PATH",
"type": "integer",
"required": true,
Expand Down Expand Up @@ -2751,6 +2751,19 @@
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "exclude_pull_requests",
"description": "If `true` pull requests are omitted from the response (empty array).",
"in": "QUERY",
"type": "boolean",
"required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
}
],
"responses": [
Expand Down Expand Up @@ -2831,6 +2844,19 @@
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "exclude_pull_requests",
"description": "If `true` pull requests are omitted from the response (empty array).",
"in": "QUERY",
"type": "boolean",
"required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
}
],
"responses": [
Expand Down Expand Up @@ -4112,6 +4138,19 @@
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "exclude_pull_requests",
"description": "If `true` pull requests are omitted from the response (empty array).",
"in": "QUERY",
"type": "boolean",
"required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
}
],
"responses": [
Expand Down Expand Up @@ -4271,6 +4310,19 @@
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "exclude_pull_requests",
"description": "If `true` pull requests are omitted from the response (empty array).",
"in": "QUERY",
"type": "boolean",
"required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
}
],
"responses": [
Expand Down

0 comments on commit 5b5e5f6

Please sign in to comment.