feat: set endpoint methods on octokit.rest.*. octokit.* is still set, but no longer documented, and will be deprecated in future (#365)

Author: gr2m

README.md

@@ -45,7 +45,7 @@ const MyOctokit = Octokit.plugin(restEndpointMethods);
 const octokit = new MyOctokit({ auth: "secret123" });
 
 // https://developer.github.com/v3/users/#get-the-authenticated-user
-octokit.users.getAuthenticated();
+octokit.rest.users.getAuthenticated();
 ```
 
 There is one method for each REST API endpoint documented at [https://developer.github.com/v3](https://developer.github.com/v3). All endpoint methods are documented in the [docs/](docs/) folder, e.g. [docs/users/getAuthenticated.md](docs/users/getAuthenticated.md)
@@ -63,6 +63,8 @@ type UpdateLabelParameters = RestEndpointMethodTypes["issues"]["updateLabel"]["p
 type UpdateLabelResponse = RestEndpointMethodTypes["issues"]["updateLabel"]["response"];
 ```
 
+In order to get types beyond parameters and responses, check out [`@octokit/openapi-types`](https://github.com/octokit/openapi-types.ts/#readme), which is a direct transpliation from GitHub's official OpenAPI specification.
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md)

docs/actions/addSelectedRepoToOrgSecret.md

@@ -1,6 +1,6 @@
 ---
 name: Add selected repository to an organization secret
-example: octokit.actions.addSelectedRepoToOrgSecret({ org, secret_name, repository_id })
+example: octokit.rest.actions.addSelectedRepoToOrgSecret({ org, secret_name, repository_id })
 route: PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}
 scope: actions
 type: API method
@@ -11,7 +11,7 @@ type: API method
 Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
 
 ```js
-octokit.actions.addSelectedRepoToOrgSecret({
+octokit.rest.actions.addSelectedRepoToOrgSecret({
   org,
   secret_name,
   repository_id,

docs/actions/cancelWorkflowRun.md

@@ -1,6 +1,6 @@
 ---
 name: Cancel a workflow run
-example: octokit.actions.cancelWorkflowRun({ owner, repo, run_id })
+example: octokit.rest.actions.cancelWorkflowRun({ owner, repo, run_id })
 route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel
 scope: actions
 type: API method
@@ -11,7 +11,7 @@ type: API method
 Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
 
 ```js
-octokit.actions.cancelWorkflowRun({
+octokit.rest.actions.cancelWorkflowRun({
   owner,
   repo,
   run_id,

docs/actions/createOrUpdateEnvironmentSecret.md

@@ -1,6 +1,6 @@
 ---
 name: Create or update an environment secret
-example: octokit.actions.createOrUpdateEnvironmentSecret({ repository_id, environment_name, secret_name })
+example: octokit.rest.actions.createOrUpdateEnvironmentSecret({ repository_id, environment_name, secret_name })
 route: PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}
 scope: actions
 type: API method
@@ -84,7 +84,7 @@ puts Base64.strict_encode64(encrypted_secret)
 ```
 
 ```js
-octokit.actions.createOrUpdateEnvironmentSecret({
+octokit.rest.actions.createOrUpdateEnvironmentSecret({
   repository_id,
   environment_name,
   secret_name,

docs/actions/createOrUpdateOrgSecret.md

@@ -1,6 +1,6 @@
 ---
 name: Create or update an organization secret
-example: octokit.actions.createOrUpdateOrgSecret({ org, secret_name })
+example: octokit.rest.actions.createOrUpdateOrgSecret({ org, secret_name })
 route: PUT /orgs/{org}/actions/secrets/{secret_name}
 scope: actions
 type: API method
@@ -84,7 +84,7 @@ puts Base64.strict_encode64(encrypted_secret)
 ```
 
 ```js
-octokit.actions.createOrUpdateOrgSecret({
+octokit.rest.actions.createOrUpdateOrgSecret({
   org,
   secret_name,
 });

docs/actions/createOrUpdateRepoSecret.md

@@ -1,6 +1,6 @@
 ---
 name: Create or update a repository secret
-example: octokit.actions.createOrUpdateRepoSecret({ owner, repo, secret_name })
+example: octokit.rest.actions.createOrUpdateRepoSecret({ owner, repo, secret_name })
 route: PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}
 scope: actions
 type: API method
@@ -84,7 +84,7 @@ puts Base64.strict_encode64(encrypted_secret)
 ```
 
 ```js
-octokit.actions.createOrUpdateRepoSecret({
+octokit.rest.actions.createOrUpdateRepoSecret({
   owner,
   repo,
   secret_name,

docs/actions/createRegistrationTokenForOrg.md

@@ -1,6 +1,6 @@
 ---
 name: Create a registration token for an organization
-example: octokit.actions.createRegistrationTokenForOrg({ org })
+example: octokit.rest.actions.createRegistrationTokenForOrg({ org })
 route: POST /orgs/{org}/actions/runners/registration-token
 scope: actions
 type: API method
@@ -21,7 +21,7 @@ Configure your self-hosted runner, replacing `TOKEN` with the registration token
 ```
 
 ```js
-octokit.actions.createRegistrationTokenForOrg({
+octokit.rest.actions.createRegistrationTokenForOrg({
   org,
 });
 ```

docs/actions/createRegistrationTokenForRepo.md

@@ -1,6 +1,6 @@
 ---
 name: Create a registration token for a repository
-example: octokit.actions.createRegistrationTokenForRepo({ owner, repo })
+example: octokit.rest.actions.createRegistrationTokenForRepo({ owner, repo })
 route: POST /repos/{owner}/{repo}/actions/runners/registration-token
 scope: actions
 type: API method
@@ -20,7 +20,7 @@ Configure your self-hosted runner, replacing `TOKEN` with the registration token
 ```
 
 ```js
-octokit.actions.createRegistrationTokenForRepo({
+octokit.rest.actions.createRegistrationTokenForRepo({
   owner,
   repo,
 });

docs/actions/createRemoveTokenForOrg.md

@@ -1,6 +1,6 @@
 ---
 name: Create a remove token for an organization
-example: octokit.actions.createRemoveTokenForOrg({ org })
+example: octokit.rest.actions.createRemoveTokenForOrg({ org })
 route: POST /orgs/{org}/actions/runners/remove-token
 scope: actions
 type: API method
@@ -22,7 +22,7 @@ endpoint.
 ```
 
 ```js
-octokit.actions.createRemoveTokenForOrg({
+octokit.rest.actions.createRemoveTokenForOrg({
   org,
 });
 ```

docs/actions/createRemoveTokenForRepo.md

@@ -1,6 +1,6 @@
 ---
 name: Create a remove token for a repository
-example: octokit.actions.createRemoveTokenForRepo({ owner, repo })
+example: octokit.rest.actions.createRemoveTokenForRepo({ owner, repo })
 route: POST /repos/{owner}/{repo}/actions/runners/remove-token
 scope: actions
 type: API method
@@ -20,7 +20,7 @@ To remove your self-hosted runner from a repository, replace TOKEN with the remo
 ```
 
 ```js
-octokit.actions.createRemoveTokenForRepo({
+octokit.rest.actions.createRemoveTokenForRepo({
   owner,
   repo,
 });