fix: improve parameter descriptions for `GET /repos/{owner}/{repo}/pu…

…lls/{pull_number}/requested_reviewers` (#205)
octokit · Jul 14, 2022 · 91e1aaa · 91e1aaa
1 parent 8fdaf1f
commit 91e1aaa
Show file tree

Hide file tree

Showing 18 changed files with 30 additions and 18 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "6.6.2",
+ "version": "6.6.3",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -31819,7 +31819,7 @@
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
  "get": {
  "summary": "List requested reviewers for a pull request",
- "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.",
  "tags": ["pulls"],
  "operationId": "pulls/list-requested-reviewers",
  "externalDocs": {

diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "6.6.2",
+ "version": "6.6.3",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -28492,7 +28492,7 @@
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
  "get": {
  "summary": "List requested reviewers for a pull request",
- "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/enterprise-server@3.2/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
  "tags": ["pulls"],
  "operationId": "pulls/list-requested-reviewers",
  "externalDocs": {

diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "6.6.2",
+ "version": "6.6.3",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -28059,7 +28059,7 @@
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
  "get": {
  "summary": "List requested reviewers for a pull request",
- "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/enterprise-server@3.3/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
  "tags": ["pulls"],
  "operationId": "pulls/list-requested-reviewers",
  "externalDocs": {

diff --git a/cache/ghes-3.4.json b/cache/ghes-3.4.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "6.6.2",
+ "version": "6.6.3",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -29478,7 +29478,7 @@
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
  "get": {
  "summary": "List requested reviewers for a pull request",
- "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/enterprise-server@3.4/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
  "tags": ["pulls"],
  "operationId": "pulls/list-requested-reviewers",
  "externalDocs": {

diff --git a/cache/ghes-3.5.json b/cache/ghes-3.5.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "6.6.2",
+ "version": "6.6.3",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -30315,7 +30315,7 @@
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
  "get": {
  "summary": "List requested reviewers for a pull request",
- "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/enterprise-server@3.5/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
  "tags": ["pulls"],
  "operationId": "pulls/list-requested-reviewers",
  "externalDocs": {

diff --git a/cache/github.ae.json b/cache/github.ae.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "6.6.2",
+ "version": "6.6.3",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -25970,7 +25970,7 @@
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
  "get": {
  "summary": "List requested reviewers for a pull request",
- "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/github-ae@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
  "tags": ["pulls"],
  "operationId": "pulls/list-requested-reviewers",
  "externalDocs": {

diff --git a/packages/openapi-types-ghes-3.2/package.json b/packages/openapi-types-ghes-3.2/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "6.6.2"
+ "openapi-version": "6.6.3"
  }
 }
diff --git a/packages/openapi-types-ghes-3.2/types.d.ts b/packages/openapi-types-ghes-3.2/types.d.ts
@@ -3475,6 +3475,7 @@ export interface paths {
  put: operations["pulls/merge"];
  };
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
+ /** 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/enterprise-server@3.2/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  get: operations["pulls/list-requested-reviewers"];
  /** This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.2/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
  post: operations["pulls/request-reviewers"];
@@ -31834,6 +31835,7 @@ export interface operations {
  };
  };
  };
+ /** 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/enterprise-server@3.2/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  "pulls/list-requested-reviewers": {
  parameters: {
  path: {

diff --git a/packages/openapi-types-ghes-3.3/package.json b/packages/openapi-types-ghes-3.3/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "6.6.2"
+ "openapi-version": "6.6.3"
  }
 }
diff --git a/packages/openapi-types-ghes-3.3/types.d.ts b/packages/openapi-types-ghes-3.3/types.d.ts
@@ -3529,6 +3529,7 @@ export interface paths {
  put: operations["pulls/merge"];
  };
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
+ /** 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/enterprise-server@3.3/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  get: operations["pulls/list-requested-reviewers"];
  /** This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.3/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
  post: operations["pulls/request-reviewers"];
@@ -32755,6 +32756,7 @@ export interface operations {
  };
  };
  };
+ /** 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/enterprise-server@3.3/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  "pulls/list-requested-reviewers": {
  parameters: {
  path: {

diff --git a/packages/openapi-types-ghes-3.4/package.json b/packages/openapi-types-ghes-3.4/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "6.6.2"
+ "openapi-version": "6.6.3"
  }
 }
diff --git a/packages/openapi-types-ghes-3.4/types.d.ts b/packages/openapi-types-ghes-3.4/types.d.ts
@@ -3863,6 +3863,7 @@ export interface paths {
  put: operations["pulls/merge"];
  };
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
+ /** 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/enterprise-server@3.4/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  get: operations["pulls/list-requested-reviewers"];
  /** This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
  post: operations["pulls/request-reviewers"];
@@ -34222,6 +34223,7 @@ export interface operations {
  };
  };
  };
+ /** 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/enterprise-server@3.4/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  "pulls/list-requested-reviewers": {
  parameters: {
  path: {

diff --git a/packages/openapi-types-ghes-3.5/package.json b/packages/openapi-types-ghes-3.5/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "6.6.2"
+ "openapi-version": "6.6.3"
  }
 }
diff --git a/packages/openapi-types-ghes-3.5/types.d.ts b/packages/openapi-types-ghes-3.5/types.d.ts
@@ -4001,6 +4001,7 @@ export interface paths {
  put: operations["pulls/merge"];
  };
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
+ /** 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/enterprise-server@3.5/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  get: operations["pulls/list-requested-reviewers"];
  /** This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
  post: operations["pulls/request-reviewers"];
@@ -35628,6 +35629,7 @@ export interface operations {
  };
  };
  };
+ /** 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/enterprise-server@3.5/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  "pulls/list-requested-reviewers": {
  parameters: {
  path: {

diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "6.6.2"
+ "openapi-version": "6.6.3"
  }
 }
diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts
@@ -3306,6 +3306,7 @@ export interface paths {
  put: operations["pulls/merge"];
  };
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
+ /** 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/github-ae@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  get: operations["pulls/list-requested-reviewers"];
  /** This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
  post: operations["pulls/request-reviewers"];
@@ -31446,6 +31447,7 @@ export interface operations {
  };
  };
  };
+ /** 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/github-ae@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
  "pulls/list-requested-reviewers": {
  parameters: {
  path: {

diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "6.6.2"
+ "openapi-version": "6.6.3"
  }
 }
diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts
@@ -4593,6 +4593,7 @@ export interface paths {
  put: operations["pulls/merge"];
  };
  "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
+ /** 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. */
  get: operations["pulls/list-requested-reviewers"];
  /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
  post: operations["pulls/request-reviewers"];
@@ -39405,6 +39406,7 @@ export interface operations {
  };
  };
  };
+ /** 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. */
  "pulls/list-requested-reviewers": {
  parameters: {
  path: {