fix: clarify docs to make it clear that `POST /repos/{owner}/{repo}/a…

…ctions/runs/{run_id}/pending_deployments` is only available to required reviewers (#506)
octokit · Jul 5, 2022 · 015cabe · 015cabe
1 parent 034de15
commit 015cabe
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/actions/reviewPendingDeploymentsForRun.md b/docs/actions/reviewPendingDeploymentsForRun.md
@@ -10,7 +10,7 @@ type: API method
 
 Approve or reject pending deployments that are waiting on approval by a required reviewer.
 
-Anyone with read access to the repository contents and deployments can use this endpoint.
+Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.
 
 ```js
 octokit.rest.actions.reviewPendingDeploymentsForRun({

diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json
@@ -5991,7 +5991,7 @@
     "isDeprecated": false,
     "deprecationDate": null,
     "removalDate": null,
-    "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.",
+    "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.",
     "documentationUrl": "https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run",
     "previews": [],
     "headers": [],

diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts
@@ -1454,7 +1454,7 @@ export type RestEndpointMethods = {
     /**
      * Approve or reject pending deployments that are waiting on approval by a required reviewer.
      *
-     * Anyone with read access to the repository contents and deployments can use this endpoint.
+     * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.
      */
     reviewPendingDeploymentsForRun: {
       (