From 015cabe80be9f76f98c28367ef56f3e0cb659512 Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Tue, 5 Jul 2022 09:40:17 -0700 Subject: [PATCH] fix: clarify docs to make it clear that `POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments` is only available to required reviewers (#506) --- docs/actions/reviewPendingDeploymentsForRun.md | 2 +- scripts/update-endpoints/generated/endpoints.json | 2 +- src/generated/method-types.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/actions/reviewPendingDeploymentsForRun.md b/docs/actions/reviewPendingDeploymentsForRun.md index dfe9cb06a..2cbbb56c2 100644 --- 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 index 068982981..4543be5e0 100644 --- 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 index 4373f85ca..3898f686e 100644 --- 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: { (