Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jul 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/actions/reviewPendingDeploymentsForRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down
2 changes: 1 addition & 1 deletion scripts/update-endpoints/generated/endpoints.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [],
Expand Down
2 changes: 1 addition & 1 deletion src/generated/method-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
(
Expand Down