Skip to content

Commit adc25ec

Browse files
authored
fix: improve parameter descriptions for GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers (#517)
1 parent 295293e commit adc25ec

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

docs/pulls/listRequestedReviewers.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ type: API method
88

99
# List requested reviewers for a pull request
1010

11+
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.
12+
1113
```js
1214
octokit.rest.pulls.listRequestedReviewers({
1315
owner,

scripts/update-endpoints/generated/endpoints.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37993,7 +37993,7 @@
3799337993
"isDeprecated": false,
3799437994
"deprecationDate": null,
3799537995
"removalDate": null,
37996-
"description": "",
37996+
"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.",
3799737997
"documentationUrl": "https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request",
3799837998
"previews": [],
3799937999
"headers": [],

src/generated/method-types.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7174,7 +7174,9 @@ export type RestEndpointMethods = {
71747174
defaults: RequestInterface["defaults"];
71757175
endpoint: EndpointInterface<{ url: string }>;
71767176
};
7177-
7177+
/**
7178+
* 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.
7179+
*/
71787180
listRequestedReviewers: {
71797181
(
71807182
params?: RestEndpointMethodTypes["pulls"]["listRequestedReviewers"]["parameters"]

0 commit comments

Comments
 (0)