feat: codeScanning.listAlertInstances(), `actions.approveWorkflowRu…

…n()`. Deprecates `codeScanning.listAlertsInstances()` (#384)
octokit · May 21, 2021 · e8087b4 · e8087b4
1 parent 8506eb6
commit e8087b4
Show file tree

Hide file tree

Showing 165 changed files with 847 additions and 446 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -14,8 +14,10 @@ jobs:
     strategy:
       matrix:
         node_version:
-          - "10"
-          - "12"
+          - 10
+          - 12
+          - 14
+          - 16
     steps:
       - uses: actions/checkout@master
       - name: "Use Node.js ${{ matrix.node_version }}"

diff --git a/docs/actions/approveWorkflowRun.md b/docs/actions/approveWorkflowRun.md
@@ -0,0 +1,50 @@
+---
+name: Approve a workflow run for a fork pull request
+example: octokit.rest.actions.approveWorkflowRun({ owner, repo, run_id })
+route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve
+scope: actions
+type: API method
+---
+
+# Approve a workflow run for a fork pull request
+
+**Note:** This endpoint is currently in beta and is subject to change.
+
+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)."
+
+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.
+
+```js
+octokit.rest.actions.approveWorkflowRun({
+  owner,
+  repo,
+  run_id,
+});
+```
+
+## Parameters
+
+<table>
+  <thead>
+    <tr>
+      <th>name</th>
+      <th>required</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr><td>owner</td><td>yes</td><td>
+
+</td></tr>
+<tr><td>repo</td><td>yes</td><td>
+
+</td></tr>
+<tr><td>run_id</td><td>yes</td><td>
+
+The id of the workflow run.
+
+</td></tr>
+  </tbody>
+</table>
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request).
diff --git a/docs/actions/cancelWorkflowRun.md b/docs/actions/cancelWorkflowRun.md
@@ -37,7 +37,7 @@ octokit.rest.actions.cancelWorkflowRun({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/deleteWorkflowRun.md b/docs/actions/deleteWorkflowRun.md
@@ -39,7 +39,7 @@ octokit.rest.actions.deleteWorkflowRun({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/deleteWorkflowRunLogs.md b/docs/actions/deleteWorkflowRunLogs.md
@@ -37,7 +37,7 @@ octokit.rest.actions.deleteWorkflowRunLogs({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/downloadWorkflowRunLogs.md b/docs/actions/downloadWorkflowRunLogs.md
@@ -40,7 +40,7 @@ octokit.rest.actions.downloadWorkflowRunLogs({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/getPendingDeploymentsForRun.md b/docs/actions/getPendingDeploymentsForRun.md
@@ -39,7 +39,7 @@ octokit.rest.actions.getPendingDeploymentsForRun({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/getReviewsForRun.md b/docs/actions/getReviewsForRun.md
@@ -37,7 +37,7 @@ octokit.rest.actions.getReviewsForRun({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/getWorkflowRun.md b/docs/actions/getWorkflowRun.md
@@ -37,7 +37,7 @@ octokit.rest.actions.getWorkflowRun({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/getWorkflowRunUsage.md b/docs/actions/getWorkflowRunUsage.md
@@ -39,7 +39,7 @@ octokit.rest.actions.getWorkflowRunUsage({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/listJobsForWorkflowRun.md b/docs/actions/listJobsForWorkflowRun.md
@@ -37,7 +37,7 @@ octokit.rest.actions.listJobsForWorkflowRun({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
 <tr><td>filter</td><td>no</td><td>

diff --git a/docs/actions/listWorkflowRunArtifacts.md b/docs/actions/listWorkflowRunArtifacts.md
@@ -37,7 +37,7 @@ octokit.rest.actions.listWorkflowRunArtifacts({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
 <tr><td>per_page</td><td>no</td><td>

diff --git a/docs/actions/reRunWorkflow.md b/docs/actions/reRunWorkflow.md
@@ -37,7 +37,7 @@ octokit.rest.actions.reRunWorkflow({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/reviewPendingDeploymentsForRun.md b/docs/actions/reviewPendingDeploymentsForRun.md
@@ -42,7 +42,7 @@ octokit.rest.actions.reviewPendingDeploymentsForRun({
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run
+The id of the workflow run.
 
 </td></tr>
 <tr><td>environment_ids</td><td>yes</td><td>

diff --git a/docs/apps/createFromManifest.md b/docs/apps/createFromManifest.md
@@ -33,4 +33,4 @@ octokit.rest.apps.createFromManifest({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#create-a-github-app-from-a-manifest).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#create-a-github-app-from-a-manifest).
diff --git a/docs/apps/deleteInstallation.md b/docs/apps/deleteInstallation.md
@@ -37,4 +37,4 @@ installation_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#delete-an-installation-for-the-authenticated-app).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#delete-an-installation-for-the-authenticated-app).
diff --git a/docs/apps/getAuthenticated.md b/docs/apps/getAuthenticated.md
@@ -20,4 +20,4 @@ octokit.rest.apps.getAuthenticated();
 
 This endpoint has no parameters
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#get-the-authenticated-app).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-the-authenticated-app).
diff --git a/docs/apps/getInstallation.md b/docs/apps/getInstallation.md
@@ -37,4 +37,4 @@ installation_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#get-an-installation-for-the-authenticated-app).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-an-installation-for-the-authenticated-app).
diff --git a/docs/apps/getOrgInstallation.md b/docs/apps/getOrgInstallation.md
@@ -35,4 +35,4 @@ octokit.rest.apps.getOrgInstallation({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#get-an-organization-installation-for-the-authenticated-app).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app).
diff --git a/docs/apps/getRepoInstallation.md b/docs/apps/getRepoInstallation.md
@@ -39,4 +39,4 @@ octokit.rest.apps.getRepoInstallation({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#get-a-repository-installation-for-the-authenticated-app).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app).
diff --git a/docs/apps/getUserInstallation.md b/docs/apps/getUserInstallation.md
@@ -35,4 +35,4 @@ octokit.rest.apps.getUserInstallation({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#get-a-user-installation-for-the-authenticated-app).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-a-user-installation-for-the-authenticated-app).
diff --git a/docs/apps/listInstallations.md b/docs/apps/listInstallations.md
@@ -48,4 +48,4 @@ Only show notifications updated after the given time. This is a timestamp in [IS
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#list-installations-for-the-authenticated-app).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app).
diff --git a/docs/apps/suspendInstallation.md b/docs/apps/suspendInstallation.md
@@ -37,4 +37,4 @@ installation_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#suspend-an-app-installation).
diff --git a/docs/apps/unsuspendInstallation.md b/docs/apps/unsuspendInstallation.md
@@ -37,4 +37,4 @@ installation_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#unsuspend-an-app-installation).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#unsuspend-an-app-installation).
diff --git a/docs/billing/getGithubActionsBillingOrg.md b/docs/billing/getGithubActionsBillingOrg.md
@@ -37,4 +37,4 @@ octokit.rest.billing.getGithubActionsBillingOrg({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing/#get-github-actions-billing-for-an-organization).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-organization).
diff --git a/docs/billing/getGithubActionsBillingUser.md b/docs/billing/getGithubActionsBillingUser.md
@@ -37,4 +37,4 @@ octokit.rest.billing.getGithubActionsBillingUser({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing/#get-github-actions-billing-for-a-user).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-a-user).
diff --git a/docs/billing/getGithubPackagesBillingOrg.md b/docs/billing/getGithubPackagesBillingOrg.md
@@ -37,4 +37,4 @@ octokit.rest.billing.getGithubPackagesBillingOrg({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing/#get-github-packages-billing-for-an-organization).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-organization).
diff --git a/docs/billing/getGithubPackagesBillingUser.md b/docs/billing/getGithubPackagesBillingUser.md
@@ -37,4 +37,4 @@ octokit.rest.billing.getGithubPackagesBillingUser({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing/#get-github-packages-billing-for-a-user).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-a-user).
diff --git a/docs/billing/getSharedStorageBillingOrg.md b/docs/billing/getSharedStorageBillingOrg.md
@@ -37,4 +37,4 @@ octokit.rest.billing.getSharedStorageBillingOrg({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing/#get-shared-storage-billing-for-an-organization).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-organization).
diff --git a/docs/billing/getSharedStorageBillingUser.md b/docs/billing/getSharedStorageBillingUser.md
@@ -37,4 +37,4 @@ octokit.rest.billing.getSharedStorageBillingUser({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing/#get-shared-storage-billing-for-a-user).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-a-user).
diff --git a/docs/codeScanning/getSarif.md b/docs/codeScanning/getSarif.md
@@ -43,4 +43,4 @@ The SARIF ID obtained after uploading.
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#get-information-about-a-sarif-upload).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-recent-code-scanning-analyses-for-a-repository).
diff --git a/docs/codeScanning/listAlertInstances.md b/docs/codeScanning/listAlertInstances.md
@@ -0,0 +1,61 @@
+---
+name: List instances of a code scanning alert
+example: octokit.rest.codeScanning.listAlertInstances({ owner, repo, alert_number })
+route: GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances
+scope: codeScanning
+type: API method
+---
+
+# List instances of a code scanning alert
+
+Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.
+
+```js
+octokit.rest.codeScanning.listAlertInstances({
+  owner,
+  repo,
+  alert_number,
+});
+```
+
+## Parameters
+
+<table>
+  <thead>
+    <tr>
+      <th>name</th>
+      <th>required</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr><td>owner</td><td>yes</td><td>
+
+</td></tr>
+<tr><td>repo</td><td>yes</td><td>
+
+</td></tr>
+<tr><td>alert_number</td><td>yes</td><td>
+
+The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
+
+</td></tr>
+<tr><td>page</td><td>no</td><td>
+
+Page number of the results to fetch.
+
+</td></tr>
+<tr><td>per_page</td><td>no</td><td>
+
+Results per page (max 100).
+
+</td></tr>
+<tr><td>ref</td><td>no</td><td>
+
+The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
+
+</td></tr>
+  </tbody>
+</table>
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert).
diff --git a/docs/codeScanning/listAlertsInstances.md b/docs/codeScanning/listAlertsInstances.md
@@ -8,6 +8,8 @@ type: API method
 
 # List instances of a code scanning alert
 
+**Deprecated:** This method has been renamed to codeScanning.listAlertInstances
+
 Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.
 
 ```js

diff --git a/docs/codeScanning/uploadSarif.md b/docs/codeScanning/uploadSarif.md
@@ -89,4 +89,4 @@ The name of the tool used to generate the code scanning analysis. If this parame
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#upload-an-analysis-as-sarif-data).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#upload-a-sarif-file).
diff --git a/docs/codesOfConduct/getAllCodesOfConduct.md b/docs/codesOfConduct/getAllCodesOfConduct.md
@@ -16,4 +16,4 @@ octokit.rest.codesOfConduct.getAllCodesOfConduct();
 
 This endpoint has no parameters
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codes_of_conduct/#get-all-codes-of-conduct).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct).
diff --git a/docs/codesOfConduct/getConductCode.md b/docs/codesOfConduct/getConductCode.md
@@ -31,4 +31,4 @@ octokit.rest.codesOfConduct.getConductCode({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codes_of_conduct/#get-a-code-of-conduct).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct).
diff --git a/docs/codesOfConduct/getForRepo.md b/docs/codesOfConduct/getForRepo.md
@@ -39,4 +39,4 @@ octokit.rest.codesOfConduct.getForRepo({
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codes_of_conduct/#get-the-code-of-conduct-for-a-repository).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository).
diff --git a/docs/emojis/get.md b/docs/emojis/get.md
@@ -18,4 +18,4 @@ octokit.rest.emojis.get();
 
 This endpoint has no parameters
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/emojis/#get-emojis).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/emojis#get-emojis).
diff --git a/docs/gists/checkIsStarred.md b/docs/gists/checkIsStarred.md
@@ -33,4 +33,4 @@ gist_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists/#check-if-a-gist-is-starred).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#check-if-a-gist-is-starred).
diff --git a/docs/gists/create.md b/docs/gists/create.md
@@ -54,4 +54,4 @@ Content of the file
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists/#create-a-gist).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#create-a-gist).
diff --git a/docs/gists/delete.md b/docs/gists/delete.md
@@ -33,4 +33,4 @@ gist_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists/#delete-a-gist).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#delete-a-gist).
diff --git a/docs/gists/fork.md b/docs/gists/fork.md
@@ -35,4 +35,4 @@ gist_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists/#fork-a-gist).
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#fork-a-gist).