Skip to content

Commit 015cabe

Browse files
authored
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)
1 parent 034de15 commit 015cabe

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/actions/reviewPendingDeploymentsForRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type: API method
1010

1111
Approve or reject pending deployments that are waiting on approval by a required reviewer.
1212

13-
Anyone with read access to the repository contents and deployments can use this endpoint.
13+
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.
1414

1515
```js
1616
octokit.rest.actions.reviewPendingDeploymentsForRun({

scripts/update-endpoints/generated/endpoints.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5991,7 +5991,7 @@
59915991
"isDeprecated": false,
59925992
"deprecationDate": null,
59935993
"removalDate": null,
5994-
"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.",
5994+
"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.",
59955995
"documentationUrl": "https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run",
59965996
"previews": [],
59975997
"headers": [],

src/generated/method-types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1454,7 +1454,7 @@ export type RestEndpointMethods = {
14541454
/**
14551455
* Approve or reject pending deployments that are waiting on approval by a required reviewer.
14561456
*
1457-
* Anyone with read access to the repository contents and deployments can use this endpoint.
1457+
* 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.
14581458
*/
14591459
reviewPendingDeploymentsForRun: {
14601460
(

0 commit comments

Comments
 (0)