fix: machine-man preview graduated (#185)

octokitbot · web-flow · commit 34559d8c91c3 · 2020-09-03T12:47:07.000-07:00
diff --git a/docs/actions/createRegistrationTokenForOrg.md b/docs/actions/createRegistrationTokenForOrg.md
@@ -8,10 +8,9 @@ type: API method
 
 # Create a registration token for an organization
 
-**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
+Returns a token that you can pass to the `config` script. The token expires after one hour.
 
-Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate
-using an access token with the `admin:org` scope to use this endpoint.
+You must authenticate using an access token with the `admin:org` scope to use this endpoint.
 
 #### Example using registration token
 
diff --git a/docs/actions/createRemoveTokenForOrg.md b/docs/actions/createRemoveTokenForOrg.md
@@ -8,11 +8,9 @@ type: API method
 
 # Create a remove token for an organization
 
-**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
+Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
 
-Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The
-token expires after one hour. You must authenticate using an access token with the `admin:org` scope to use this
-endpoint.
+You must authenticate using an access token with the `admin:org` scope to use this endpoint.
 
 #### Example using remove token
 
diff --git a/docs/actions/deleteSelfHostedRunnerFromOrg.md b/docs/actions/deleteSelfHostedRunnerFromOrg.md
@@ -8,9 +8,9 @@ type: API method
 
 # Delete a self-hosted runner from an organization
 
-**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
+Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
 
-Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+You must authenticate using an access token with the `admin:org` scope to use this endpoint.
 
 ```js
 octokit.actions.deleteSelfHostedRunnerFromOrg({
@@ -35,6 +35,8 @@ octokit.actions.deleteSelfHostedRunnerFromOrg({
 </td></tr>
 <tr><td>runner_id</td><td>yes</td><td>
 
+Unique identifier of the self-hosted runner.
+
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/actions/deleteSelfHostedRunnerFromRepo.md b/docs/actions/deleteSelfHostedRunnerFromRepo.md
@@ -8,7 +8,10 @@ type: API method
 
 # Delete a self-hosted runner from a repository
 
-Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the `repo` scope to use this endpoint.
+Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
+
+You must authenticate using an access token with the `repo`
+scope to use this endpoint.
 
 ```js
 octokit.actions.deleteSelfHostedRunnerFromRepo({
@@ -37,6 +40,8 @@ octokit.actions.deleteSelfHostedRunnerFromRepo({
 </td></tr>
 <tr><td>runner_id</td><td>yes</td><td>
 
+Unique identifier of the self-hosted runner.
+
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/actions/getSelfHostedRunnerForOrg.md b/docs/actions/getSelfHostedRunnerForOrg.md
@@ -8,9 +8,9 @@ type: API method
 
 # Get a self-hosted runner for an organization
 
-**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
+Gets a specific self-hosted runner configured in an organization.
 
-Gets a specific self-hosted runner for an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+You must authenticate using an access token with the `admin:org` scope to use this endpoint.
 
 ```js
 octokit.actions.getSelfHostedRunnerForOrg({
@@ -35,6 +35,8 @@ octokit.actions.getSelfHostedRunnerForOrg({
 </td></tr>
 <tr><td>runner_id</td><td>yes</td><td>
 
+Unique identifier of the self-hosted runner.
+
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/actions/getSelfHostedRunnerForRepo.md b/docs/actions/getSelfHostedRunnerForRepo.md
@@ -8,7 +8,10 @@ type: API method
 
 # Get a self-hosted runner for a repository
 
-Gets a specific self-hosted runner. You must authenticate using an access token with the `repo` scope to use this endpoint.
+Gets a specific self-hosted runner configured in a repository.
+
+You must authenticate using an access token with the `repo` scope to use this
+endpoint.
 
 ```js
 octokit.actions.getSelfHostedRunnerForRepo({
@@ -37,6 +40,8 @@ octokit.actions.getSelfHostedRunnerForRepo({
 </td></tr>
 <tr><td>runner_id</td><td>yes</td><td>
 
+Unique identifier of the self-hosted runner.
+
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/actions/listRunnerApplicationsForOrg.md b/docs/actions/listRunnerApplicationsForOrg.md
@@ -8,9 +8,9 @@ type: API method
 
 # List runner applications for an organization
 
-**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
+Lists binaries for the runner application that you can download and run.
 
-Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+You must authenticate using an access token with the `admin:org` scope to use this endpoint.
 
 ```js
 octokit.actions.listRunnerApplicationsForOrg({
diff --git a/docs/actions/listRunnerApplicationsForRepo.md b/docs/actions/listRunnerApplicationsForRepo.md
@@ -8,7 +8,9 @@ type: API method
 
 # List runner applications for a repository
 
-Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the `repo` scope to use this endpoint.
+Lists binaries for the runner application that you can download and run.
+
+You must authenticate using an access token with the `repo` scope to use this endpoint.
 
 ```js
 octokit.actions.listRunnerApplicationsForRepo({
diff --git a/docs/actions/listSelfHostedRunnersForOrg.md b/docs/actions/listSelfHostedRunnersForOrg.md
@@ -8,9 +8,9 @@ type: API method
 
 # List self-hosted runners for an organization
 
-**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
+Lists all self-hosted runners configured in an organization.
 
-Lists all self-hosted runners for an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+You must authenticate using an access token with the `admin:org` scope to use this endpoint.
 
 ```js
 octokit.actions.listSelfHostedRunnersForOrg({
diff --git a/docs/actions/listSelfHostedRunnersForRepo.md b/docs/actions/listSelfHostedRunnersForRepo.md
@@ -8,7 +8,8 @@ type: API method
 
 # List self-hosted runners for a repository
 
-Lists all self-hosted runners for a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.
+Lists all self-hosted runners configured in a repository.
+You must authenticate using an access token with the `repo` scope to use this endpoint.
 
 ```js
 octokit.actions.listSelfHostedRunnersForRepo({
diff --git a/docs/repos/createPagesSite.md b/docs/repos/createPagesSite.md
@@ -1,18 +1,22 @@
 ---
 name: Create a GitHub Pages site
-example: octokit.repos.createPagesSite({ owner, repo })
+example: octokit.repos.createPagesSite({ owner, repo, source, source.branch })
 route: POST /repos/{owner}/{repo}/pages
 scope: repos
 type: API method
 ---
 
 # Create a GitHub Pages site
 
+Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
+
 ```js
 octokit.repos.createPagesSite({
-  owner,
-  repo,
-});
+        owner,
+repo,
+source,
+source.branch
+      })
 ```
 
 ## Parameters
@@ -32,17 +36,19 @@ octokit.repos.createPagesSite({
 <tr><td>repo</td><td>yes</td><td>
 
 </td></tr>
-<tr><td>source</td><td>no</td><td>
+<tr><td>source</td><td>yes</td><td>
+
+The source branch and directory used to publish your Pages site.
 
 </td></tr>
-<tr><td>source.branch</td><td>no</td><td>
+<tr><td>source.branch</td><td>yes</td><td>
 
-The repository branch used to publish your [site's source files](https://docs.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.
+The repository branch used to publish your site's source files.
 
 </td></tr>
 <tr><td>source.path</td><td>no</td><td>
 
-The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.
+The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`
 
 </td></tr>
   </tbody>
diff --git a/docs/repos/getCommit.md b/docs/repos/getCommit.md
@@ -8,33 +8,72 @@ type: API method
 
 # Get a commit
 
-Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
+Returns the contents of a single commit reference. You must have `read` access for the repository to use this
+endpoint.
 
-You can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
+**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
 
-To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
+You can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to
+fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
+
+To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media
+type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use
+this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by
+providing the local SHA-1 reference as the ETag.
 
 **Signature verification object**
 
-The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
+The response will include a `verification` object that describes the result of verifying the commit's signature. The
+following fields are included in the `verification` object:
 
 These are the possible values for `reason` in the `verification` object:
 
-| Value                    | Description                                                                                                                       |
-| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
-| `expired_key`            | The key that made the signature is expired.                                                                                       |
-| `not_signing_key`        | The "signing" flag is not among the usage flags in the GPG key that made the signature.                                           |
-| `gpgverify_error`        | There was an error communicating with the signature verification service.                                                         |
-| `gpgverify_unavailable`  | The signature verification service is currently unavailable.                                                                      |
-| `unsigned`               | The object does not include a signature.                                                                                          |
-| `unknown_signature_type` | A non-PGP signature was found in the commit.                                                                                      |
-| `no_user`                | No user was associated with the `committer` email address in the commit.                                                          |
-| `unverified_email`       | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
-| `bad_email`              | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.             |
-| `unknown_key`            | The key that made the signature has not been registered with any user's account.                                                  |
-| `malformed_signature`    | There was an error parsing the signature.                                                                                         |
-| `invalid`                | The signature could not be cryptographically verified using the key whose key-id was found in the signature.                      |
-| `valid`                  | None of the above errors applied, so the signature is considered to be verified.                                                  |
+| Value |
+Description  
+|
+
+## | ------------------------ |
+
+|
+
+| `expired_key` | The key that made the signature is
+expired. |
+
+| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the
+signature. |
+
+| `gpgverify_error` | There was an error communicating with the signature verification
+service. |
+
+| `gpgverify_unavailable` | The signature verification service is currently
+unavailable. |
+
+| `unsigned` | The object does not include a
+signature. |
+
+| `unknown_signature_type` | A non-PGP signature was found in the
+commit. |
+
+| `no_user` | No user was associated with the `committer` email address in the
+commit. |
+
+| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email
+address is not verified on her/his account. |
+
+| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP
+key that made the signature. |
+
+| `unknown_key` | The key that made the signature has not been registered with any user's
+account. |
+
+| `malformed_signature` | There was an error parsing the
+signature. |
+
+| `invalid` | The signature could not be cryptographically verified using the key whose key-id was
+found in the signature. |
+
+| `valid` | None of the above errors applied, so the signature is considered to be
+verified. |
 
 ```js
 octokit.repos.getCommit({
diff --git a/docs/repos/updateInformationAboutPagesSite.md b/docs/repos/updateInformationAboutPagesSite.md
@@ -1,18 +1,23 @@
 ---
 name: Update information about a GitHub Pages site
-example: octokit.repos.updateInformationAboutPagesSite({ owner, repo })
+example: octokit.repos.updateInformationAboutPagesSite({ owner, repo, source, source.branch, source.path })
 route: PUT /repos/{owner}/{repo}/pages
 scope: repos
 type: API method
 ---
 
 # Update information about a GitHub Pages site
 
+Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
+
 ```js
 octokit.repos.updateInformationAboutPagesSite({
-  owner,
-  repo,
-});
+        owner,
+repo,
+source,
+source.branch,
+source.path
+      })
 ```
 
 ## Parameters
@@ -37,9 +42,19 @@ octokit.repos.updateInformationAboutPagesSite({
 Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)."
 
 </td></tr>
-<tr><td>source</td><td>no</td><td>
+<tr><td>source</td><td>yes</td><td>
+
+Update the source for the repository. Must include the branch name and path.
+
+</td></tr>
+<tr><td>source.branch</td><td>yes</td><td>
+
+The repository branch used to publish your site's source files.
+
+</td></tr>
+<tr><td>source.path</td><td>yes</td><td>
 
-Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`.
+The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.
 
 </td></tr>
   </tbody>
diff --git a/package.json b/package.json
@@ -24,7 +24,7 @@
   "author": "Gregor Martynus (https://twitter.com/gr2m)",
   "license": "MIT",
   "dependencies": {
-    "@octokit/types": "^5.1.1",
+    "@octokit/types": "^5.4.1",
     "deprecation": "^2.3.1"
   },
   "devDependencies": {
diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json
diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts
diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts
diff --git a/test/rest-endpoint-methods.test.ts b/test/rest-endpoint-methods.test.ts
