fix(typescript): update documentation on endpoints (#639)

WIP octokit/openapi updated
octokit · May 17, 2023 · a7ff767 · a7ff767
1 parent 6ab7627
commit a7ff767
Show file tree

Hide file tree

Showing 11 changed files with 9,456 additions and 41,486 deletions.
diff --git a/docs/pulls/checkIfMerged.md b/docs/pulls/checkIfMerged.md
@@ -8,6 +8,8 @@ type: API method
 
 # Check if a pull request has been merged
 
+Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
+
 ```js
 octokit.rest.pulls.checkIfMerged({
   owner,

diff --git a/docs/pulls/deletePendingReview.md b/docs/pulls/deletePendingReview.md
@@ -8,6 +8,8 @@ type: API method
 
 # Delete a pending review for a pull request
 
+Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
+
 ```js
 octokit.rest.pulls.deletePendingReview({
   owner,

diff --git a/docs/pulls/getReview.md b/docs/pulls/getReview.md
@@ -8,6 +8,8 @@ type: API method
 
 # Get a review for a pull request
 
+Retrieves a pull request review by its ID.
+
 ```js
 octokit.rest.pulls.getReview({
   owner,

diff --git a/docs/pulls/merge.md b/docs/pulls/merge.md
@@ -8,6 +8,7 @@ type: API method
 
 # Merge a pull request
 
+Merges a pull request into the base branch.
 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.
 
 ```js

diff --git a/docs/pulls/removeRequestedReviewers.md b/docs/pulls/removeRequestedReviewers.md
@@ -8,6 +8,8 @@ type: API method
 
 # Remove requested reviewers from a pull request
 
+Removes review requests from a pull request for a given set of users and/or teams.
+
 ```js
 octokit.rest.pulls.removeRequestedReviewers({
   owner,

diff --git a/docs/repos/getLatestPagesBuild.md b/docs/repos/getLatestPagesBuild.md
@@ -8,6 +8,10 @@ type: API method
 
 # Get latest Pages build
 
+Gets information about the single most recent build of a GitHub Pages site.
+
+A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+
 ```js
 octokit.rest.repos.getLatestPagesBuild({
   owner,

diff --git a/docs/repos/getPages.md b/docs/repos/getPages.md
@@ -8,6 +8,10 @@ type: API method
 
 # Get a GitHub Pages site
 
+Gets information about a GitHub Pages site.
+
+A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+
 ```js
 octokit.rest.repos.getPages({
   owner,

diff --git a/docs/repos/getPagesBuild.md b/docs/repos/getPagesBuild.md
@@ -8,6 +8,10 @@ type: API method
 
 # Get GitHub Pages build
 
+Gets information about a GitHub Pages build.
+
+A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+
 ```js
 octokit.rest.repos.getPagesBuild({
   owner,

diff --git a/docs/repos/listPagesBuilds.md b/docs/repos/listPagesBuilds.md
@@ -8,6 +8,10 @@ type: API method
 
 # List GitHub Pages builds
 
+Lists builts of a GitHub Pages site.
+
+A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+
 ```js
 octokit.rest.repos.listPagesBuilds({
   owner,

diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json
diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts
@@ -7932,6 +7932,9 @@ export type RestEndpointMethods = {
     };
   };
   pulls: {
+    /**
+     * Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
+     */
     checkIfMerged: {
       (
         params?: RestEndpointMethodTypes["pulls"]["checkIfMerged"]["parameters"]
@@ -8001,7 +8004,9 @@ export type RestEndpointMethods = {
       defaults: RequestInterface["defaults"];
       endpoint: EndpointInterface<{ url: string }>;
     };
-
+    /**
+     * Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
+     */
     deletePendingReview: {
       (
         params?: RestEndpointMethodTypes["pulls"]["deletePendingReview"]["parameters"]
@@ -8057,7 +8062,9 @@ export type RestEndpointMethods = {
       defaults: RequestInterface["defaults"];
       endpoint: EndpointInterface<{ url: string }>;
     };
-
+    /**
+     * Retrieves a pull request review by its ID.
+     */
     getReview: {
       (
         params?: RestEndpointMethodTypes["pulls"]["getReview"]["parameters"]
@@ -8166,6 +8173,7 @@ export type RestEndpointMethods = {
       endpoint: EndpointInterface<{ url: string }>;
     };
     /**
+     * Merges a pull request into the base branch.
      * 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.
      */
     merge: {
@@ -8175,7 +8183,9 @@ export type RestEndpointMethods = {
       defaults: RequestInterface["defaults"];
       endpoint: EndpointInterface<{ url: string }>;
     };
-
+    /**
+     * Removes review requests from a pull request for a given set of users and/or teams.
+     */
     removeRequestedReviewers: {
       (
         params?: RestEndpointMethodTypes["pulls"]["removeRequestedReviewers"]["parameters"]
@@ -10062,7 +10072,11 @@ export type RestEndpointMethods = {
       defaults: RequestInterface["defaults"];
       endpoint: EndpointInterface<{ url: string }>;
     };
-
+    /**
+     * Gets information about the single most recent build of a GitHub Pages site.
+     *
+     * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+     */
     getLatestPagesBuild: {
       (
         params?: RestEndpointMethodTypes["repos"]["getLatestPagesBuild"]["parameters"]
@@ -10108,15 +10122,23 @@ export type RestEndpointMethods = {
       defaults: RequestInterface["defaults"];
       endpoint: EndpointInterface<{ url: string }>;
     };
-
+    /**
+     * Gets information about a GitHub Pages site.
+     *
+     * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+     */
     getPages: {
       (
         params?: RestEndpointMethodTypes["repos"]["getPages"]["parameters"]
       ): Promise<RestEndpointMethodTypes["repos"]["getPages"]["response"]>;
       defaults: RequestInterface["defaults"];
       endpoint: EndpointInterface<{ url: string }>;
     };
-
+    /**
+     * Gets information about a GitHub Pages build.
+     *
+     * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+     */
     getPagesBuild: {
       (
         params?: RestEndpointMethodTypes["repos"]["getPagesBuild"]["parameters"]
@@ -10662,7 +10684,11 @@ export type RestEndpointMethods = {
       defaults: RequestInterface["defaults"];
       endpoint: EndpointInterface<{ url: string }>;
     };
-
+    /**
+     * Lists builts of a GitHub Pages site.
+     *
+     * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
+     */
     listPagesBuilds: {
       (
         params?: RestEndpointMethodTypes["repos"]["listPagesBuilds"]["parameters"]