octokit · gr2m · Jan 22, 2021 · Jan 22, 2021 · Jan 22, 2021
diff --git a/docs/repos/addAppAccessRestrictions.md b/docs/repos/addAppAccessRestrictions.md
@@ -44,7 +44,7 @@ octokit.repos.addAppAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>apps</td><td>yes</td><td>

diff --git a/docs/repos/addStatusCheckContexts.md b/docs/repos/addStatusCheckContexts.md
@@ -38,7 +38,7 @@ octokit.repos.addStatusCheckContexts({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>contexts</td><td>yes</td><td>

diff --git a/docs/repos/addTeamAccessRestrictions.md b/docs/repos/addTeamAccessRestrictions.md
@@ -44,7 +44,7 @@ octokit.repos.addTeamAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>teams</td><td>yes</td><td>

diff --git a/docs/repos/addUserAccessRestrictions.md b/docs/repos/addUserAccessRestrictions.md
@@ -44,7 +44,7 @@ octokit.repos.addUserAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>users</td><td>yes</td><td>

diff --git a/docs/repos/createCommitSignatureProtection.md b/docs/repos/createCommitSignatureProtection.md
@@ -39,7 +39,7 @@ octokit.repos.createCommitSignatureProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/deleteAccessRestrictions.md b/docs/repos/deleteAccessRestrictions.md
@@ -39,7 +39,7 @@ octokit.repos.deleteAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/deleteAdminBranchProtection.md b/docs/repos/deleteAdminBranchProtection.md
@@ -39,7 +39,7 @@ octokit.repos.deleteAdminBranchProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/deleteBranchProtection.md b/docs/repos/deleteBranchProtection.md
@@ -37,7 +37,7 @@ octokit.repos.deleteBranchProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/deleteCommitSignatureProtection.md b/docs/repos/deleteCommitSignatureProtection.md
@@ -39,7 +39,7 @@ octokit.repos.deleteCommitSignatureProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/deletePullRequestReviewProtection.md b/docs/repos/deletePullRequestReviewProtection.md
@@ -37,7 +37,7 @@ octokit.repos.deletePullRequestReviewProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getAccessRestrictions.md b/docs/repos/getAccessRestrictions.md
@@ -41,7 +41,7 @@ octokit.repos.getAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getAdminBranchProtection.md b/docs/repos/getAdminBranchProtection.md
@@ -37,7 +37,7 @@ octokit.repos.getAdminBranchProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getAllStatusCheckContexts.md b/docs/repos/getAllStatusCheckContexts.md
@@ -37,7 +37,7 @@ octokit.repos.getAllStatusCheckContexts({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getAppsWithAccessToProtectedBranch.md b/docs/repos/getAppsWithAccessToProtectedBranch.md
@@ -39,7 +39,7 @@ octokit.repos.getAppsWithAccessToProtectedBranch({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getBranch.md b/docs/repos/getBranch.md
@@ -35,7 +35,7 @@ octokit.repos.getBranch({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getBranchProtection.md b/docs/repos/getBranchProtection.md
@@ -37,7 +37,7 @@ octokit.repos.getBranchProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getCommitSignatureProtection.md b/docs/repos/getCommitSignatureProtection.md
@@ -41,7 +41,7 @@ octokit.repos.getCommitSignatureProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getPullRequestReviewProtection.md b/docs/repos/getPullRequestReviewProtection.md
@@ -37,7 +37,7 @@ octokit.repos.getPullRequestReviewProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getStatusChecksProtection.md b/docs/repos/getStatusChecksProtection.md
@@ -37,7 +37,7 @@ octokit.repos.getStatusChecksProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getTeamsWithAccessToProtectedBranch.md b/docs/repos/getTeamsWithAccessToProtectedBranch.md
@@ -39,7 +39,7 @@ octokit.repos.getTeamsWithAccessToProtectedBranch({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/getUsersWithAccessToProtectedBranch.md b/docs/repos/getUsersWithAccessToProtectedBranch.md
@@ -39,7 +39,7 @@ octokit.repos.getUsersWithAccessToProtectedBranch({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/removeAppAccessRestrictions.md b/docs/repos/removeAppAccessRestrictions.md
@@ -44,7 +44,7 @@ octokit.repos.removeAppAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>apps</td><td>yes</td><td>

diff --git a/docs/repos/removeStatusCheckContexts.md b/docs/repos/removeStatusCheckContexts.md
@@ -38,7 +38,7 @@ octokit.repos.removeStatusCheckContexts({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>contexts</td><td>yes</td><td>

diff --git a/docs/repos/removeStatusCheckProtection.md b/docs/repos/removeStatusCheckProtection.md
@@ -37,7 +37,7 @@ octokit.repos.removeStatusCheckProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/removeTeamAccessRestrictions.md b/docs/repos/removeTeamAccessRestrictions.md
@@ -44,7 +44,7 @@ octokit.repos.removeTeamAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>teams</td><td>yes</td><td>

diff --git a/docs/repos/removeUserAccessRestrictions.md b/docs/repos/removeUserAccessRestrictions.md
@@ -44,7 +44,7 @@ octokit.repos.removeUserAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>users</td><td>yes</td><td>

diff --git a/docs/repos/renameBranch.md b/docs/repos/renameBranch.md
@@ -0,0 +1,66 @@
+---
+name: Rename a branch
+example: octokit.repos.renameBranch({ owner, repo, branch, new_name })
+route: POST /repos/{owner}/{repo}/branches/{branch}/rename
+scope: repos
+type: API method
+---
+
+# Rename a branch
+
+Renames a branch in a repository.
+
+**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".
+
+The permissions required to use this endpoint depends on whether you are renaming the default branch.
+
+To rename a non-default branch:
+
+- Users must have push access.
+- GitHub Apps must have the `contents:write` repository permission.
+
+To rename the default branch:
+
+- Users must have admin or owner permissions.
+- GitHub Apps must have the `administration:write` repository permission.
+
+```js
+octokit.repos.renameBranch({
+  owner,
+  repo,
+  branch,
+  new_name,
+});
+```
+
+## Parameters
+
+<table>
+  <thead>
+    <tr>
+      <th>name</th>
+      <th>required</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr><td>owner</td><td>yes</td><td>
+
+</td></tr>
+<tr><td>repo</td><td>yes</td><td>
+
+</td></tr>
+<tr><td>branch</td><td>yes</td><td>
+
+The name of the branch.
+
+</td></tr>
+<tr><td>new_name</td><td>yes</td><td>
+
+The new name of the branch.
+
+</td></tr>
+  </tbody>
+</table>
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#rename-a-branch).
diff --git a/docs/repos/setAdminBranchProtection.md b/docs/repos/setAdminBranchProtection.md
@@ -39,7 +39,7 @@ octokit.repos.setAdminBranchProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
   </tbody>

diff --git a/docs/repos/setAppAccessRestrictions.md b/docs/repos/setAppAccessRestrictions.md
@@ -44,7 +44,7 @@ octokit.repos.setAppAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>apps</td><td>yes</td><td>

diff --git a/docs/repos/setStatusCheckContexts.md b/docs/repos/setStatusCheckContexts.md
@@ -38,7 +38,7 @@ octokit.repos.setStatusCheckContexts({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>contexts</td><td>yes</td><td>

diff --git a/docs/repos/setTeamAccessRestrictions.md b/docs/repos/setTeamAccessRestrictions.md
@@ -44,7 +44,7 @@ octokit.repos.setTeamAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>teams</td><td>yes</td><td>

diff --git a/docs/repos/setUserAccessRestrictions.md b/docs/repos/setUserAccessRestrictions.md
@@ -44,7 +44,7 @@ octokit.repos.setUserAccessRestrictions({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>users</td><td>yes</td><td>

diff --git a/docs/repos/updateBranchProtection.md b/docs/repos/updateBranchProtection.md
@@ -51,7 +51,7 @@ restrictions.teams
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>required_status_checks</td><td>yes</td><td>

diff --git a/docs/repos/updatePullRequestReviewProtection.md b/docs/repos/updatePullRequestReviewProtection.md
@@ -41,7 +41,7 @@ octokit.repos.updatePullRequestReviewProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>dismissal_restrictions</td><td>no</td><td>

diff --git a/docs/repos/updateStatusCheckPotection.md b/docs/repos/updateStatusCheckPotection.md
@@ -41,7 +41,7 @@ octokit.repos.updateStatusCheckPotection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>strict</td><td>no</td><td>

diff --git a/docs/repos/updateStatusCheckProtection.md b/docs/repos/updateStatusCheckProtection.md
@@ -39,7 +39,7 @@ octokit.repos.updateStatusCheckProtection({
 </td></tr>
 <tr><td>branch</td><td>yes</td><td>
 
-branch+ parameter
+The name of the branch.
 
 </td></tr>
 <tr><td>strict</td><td>no</td><td>