Skip to content

Commit 6867003

Browse files
committed
WIP octokit/openapi updated
1 parent 6df4d88 commit 6867003

17 files changed

+279
-25
lines changed

docs/actions/approveWorkflowRun.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Approve a workflow run for a fork pull request
3+
example: octokit.rest.actions.approveWorkflowRun({ owner, repo, run_id })
4+
route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Approve a workflow run for a fork pull request
10+
11+
**Note:** This endpoint is currently in beta and is subject to change.
12+
13+
Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
14+
15+
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
16+
17+
```js
18+
octokit.rest.actions.approveWorkflowRun({
19+
owner,
20+
repo,
21+
run_id,
22+
});
23+
```
24+
25+
## Parameters
26+
27+
<table>
28+
<thead>
29+
<tr>
30+
<th>name</th>
31+
<th>required</th>
32+
<th>description</th>
33+
</tr>
34+
</thead>
35+
<tbody>
36+
<tr><td>owner</td><td>yes</td><td>
37+
38+
</td></tr>
39+
<tr><td>repo</td><td>yes</td><td>
40+
41+
</td></tr>
42+
<tr><td>run_id</td><td>yes</td><td>
43+
44+
The id of the workflow run.
45+
46+
</td></tr>
47+
</tbody>
48+
</table>
49+
50+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request).

docs/actions/cancelWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ octokit.rest.actions.cancelWorkflowRun({
3737
</td></tr>
3838
<tr><td>run_id</td><td>yes</td><td>
3939

40-
The id of the workflow run
40+
The id of the workflow run.
4141

4242
</td></tr>
4343
</tbody>

docs/actions/deleteWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ octokit.rest.actions.deleteWorkflowRun({
3939
</td></tr>
4040
<tr><td>run_id</td><td>yes</td><td>
4141

42-
The id of the workflow run
42+
The id of the workflow run.
4343

4444
</td></tr>
4545
</tbody>

docs/actions/deleteWorkflowRunLogs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ octokit.rest.actions.deleteWorkflowRunLogs({
3737
</td></tr>
3838
<tr><td>run_id</td><td>yes</td><td>
3939

40-
The id of the workflow run
40+
The id of the workflow run.
4141

4242
</td></tr>
4343
</tbody>

docs/actions/downloadWorkflowRunLogs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ octokit.rest.actions.downloadWorkflowRunLogs({
4040
</td></tr>
4141
<tr><td>run_id</td><td>yes</td><td>
4242

43-
The id of the workflow run
43+
The id of the workflow run.
4444

4545
</td></tr>
4646
</tbody>

docs/actions/getPendingDeploymentsForRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ octokit.rest.actions.getPendingDeploymentsForRun({
3939
</td></tr>
4040
<tr><td>run_id</td><td>yes</td><td>
4141

42-
The id of the workflow run
42+
The id of the workflow run.
4343

4444
</td></tr>
4545
</tbody>

docs/actions/getReviewsForRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ octokit.rest.actions.getReviewsForRun({
3737
</td></tr>
3838
<tr><td>run_id</td><td>yes</td><td>
3939

40-
The id of the workflow run
40+
The id of the workflow run.
4141

4242
</td></tr>
4343
</tbody>

docs/actions/getWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ octokit.rest.actions.getWorkflowRun({
3737
</td></tr>
3838
<tr><td>run_id</td><td>yes</td><td>
3939

40-
The id of the workflow run
40+
The id of the workflow run.
4141

4242
</td></tr>
4343
</tbody>

docs/actions/getWorkflowRunUsage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ octokit.rest.actions.getWorkflowRunUsage({
3939
</td></tr>
4040
<tr><td>run_id</td><td>yes</td><td>
4141

42-
The id of the workflow run
42+
The id of the workflow run.
4343

4444
</td></tr>
4545
</tbody>

docs/actions/listJobsForWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ octokit.rest.actions.listJobsForWorkflowRun({
3737
</td></tr>
3838
<tr><td>run_id</td><td>yes</td><td>
3939

40-
The id of the workflow run
40+
The id of the workflow run.
4141

4242
</td></tr>
4343
<tr><td>filter</td><td>no</td><td>

docs/actions/listWorkflowRunArtifacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ octokit.rest.actions.listWorkflowRunArtifacts({
3737
</td></tr>
3838
<tr><td>run_id</td><td>yes</td><td>
3939

40-
The id of the workflow run
40+
The id of the workflow run.
4141

4242
</td></tr>
4343
<tr><td>per_page</td><td>no</td><td>

docs/actions/reRunWorkflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ octokit.rest.actions.reRunWorkflow({
3737
</td></tr>
3838
<tr><td>run_id</td><td>yes</td><td>
3939

40-
The id of the workflow run
40+
The id of the workflow run.
4141

4242
</td></tr>
4343
</tbody>

docs/actions/reviewPendingDeploymentsForRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ octokit.rest.actions.reviewPendingDeploymentsForRun({
4242
</td></tr>
4343
<tr><td>run_id</td><td>yes</td><td>
4444

45-
The id of the workflow run
45+
The id of the workflow run.
4646

4747
</td></tr>
4848
<tr><td>environment_ids</td><td>yes</td><td>

0 commit comments

Comments
 (0)