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.

Sign up for GitHub

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

Jump to bottom

fix: improve parameter descriptions for GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers #517

Merged
merged 1 commit into from
Jul 14, 2022
Merged

fix: improve parameter descriptions for GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers #517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions docs/pulls/listRequestedReviewers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ type: API method

# List requested reviewers for a pull request

Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.

```js
octokit.rest.pulls.listRequestedReviewers({
owner,
Expand Down
2 changes: 1 addition & 1 deletion scripts/update-endpoints/generated/endpoints.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37993,7 +37993,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
"description": "",
"description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
"documentationUrl": "https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request",
"previews": [],
"headers": [],
Expand Down
4 changes: 3 additions & 1 deletion src/generated/method-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7174,7 +7174,9 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};

/**
* Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.
*/
listRequestedReviewers: {
(
params?: RestEndpointMethodTypes["pulls"]["listRequestedReviewers"]["parameters"]
Expand Down