Reimplement as PATCH /branches/* endpoint

Co-authored-by: wxiaoguang <[email protected]>

Author: kemzeb

modules/structs/repo.go

@@ -278,19 +278,13 @@ type CreateBranchRepoOption struct {
 	OldRefName string `json:"old_ref_name" binding:"GitRefName;MaxSize(100)"`
 }
 
-// RenameBranchOption options when rename a branch in a repository
+// UpdateBranchRepoOption options when updating a branch in a repository
 // swagger:model
-type RenameBranchRepoOption struct {
-	// Old branch name
-	//
-	// required: true
-	// unique: true
-	OldName string `json:"old_name" binding:"Required;GitRefName;MaxSize(100)"`
+type UpdateBranchRepoOption struct {
 	// New branch name
 	//
-	// required: true
 	// unique: true
-	NewName string `json:"new_name" binding:"Required;GitRefName;MaxSize(100)"`
+	Name string `json:"name" binding:"GitRefName;MaxSize(100)"`
 }
 
 // TransferRepoOption options when transfer a repository's ownership

routers/api/v1/api.go

@@ -1195,7 +1195,7 @@ func Routes() *web.Router {
 					m.Get("/*", repo.GetBranch)
 					m.Delete("/*", reqToken(), reqRepoWriter(unit.TypeCode), mustNotBeArchived, repo.DeleteBranch)
 					m.Post("", reqToken(), reqRepoWriter(unit.TypeCode), mustNotBeArchived, bind(api.CreateBranchRepoOption{}), repo.CreateBranch)
-					m.Post("/rename", tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository), reqRepoWriter(unit.TypeCode), bind(api.RenameBranchRepoOption{}), repo.RenameBranch)
+					m.Patch("/*", reqToken(), reqRepoWriter(unit.TypeCode), mustNotBeArchived, bind(api.UpdateBranchRepoOption{}), repo.UpdateBranch)
 				}, context.ReferencesGitRepo(), reqRepoReader(unit.TypeCode))
 				m.Group("/branch_protections", func() {
 					m.Get("", repo.ListBranchProtections)

routers/api/v1/repo/branch.go

@@ -396,11 +396,11 @@ func ListBranches(ctx *context.APIContext) {
 	ctx.JSON(http.StatusOK, apiBranches)
 }
 
-// RenameBranch renames a repository's branch.
-func RenameBranch(ctx *context.APIContext) {
-	// swagger:operation POST /repos/{owner}/{repo}/branches/rename repository repoRenameBranch
+// UpdateBranch renames a repository's branch.
+func UpdateBranch(ctx *context.APIContext) {
+	// swagger:operation PATCH /repos/{owner}/{repo}/branches/{branch} repository repoUpdateBranch
 	// ---
-	// summary: Rename a branch
+	// summary: Update a branch
 	// consumes:
 	// - application/json
 	// produces:
@@ -416,12 +416,16 @@ func RenameBranch(ctx *context.APIContext) {
 	//   description: name of the repo
 	//   type: string
 	//   required: true
+	// - name: branch
+	//   in: path
+	//   description: name of the branch
+	//   type: string
 	// - name: body
 	//   in: body
 	//   schema:
-	//     "$ref": "#/definitions/RenameBranchRepoOption"
+	//     "$ref": "#/definitions/UpdateBranchRepoOption"
 	// responses:
-	//   "201":
+	//   "200":
 	//     "$ref": "#/responses/Branch"
 	//   "403":
 	//     "$ref": "#/responses/forbidden"
@@ -430,7 +434,9 @@ func RenameBranch(ctx *context.APIContext) {
 	//   "422":
 	//     "$ref": "#/responses/validationError"
 
-	opt := web.GetForm(ctx).(*api.RenameBranchRepoOption)
+	opt := web.GetForm(ctx).(*api.UpdateBranchRepoOption)
+
+	oldName := ctx.PathParam("*")
 	repo := ctx.Repo.Repository
 
 	if repo.IsEmpty {
@@ -443,17 +449,26 @@ func RenameBranch(ctx *context.APIContext) {
 		return
 	}
 
-	msg, err := repo_service.RenameBranch(ctx, repo, ctx.Doer, ctx.Repo.GitRepo, opt.OldName, opt.NewName)
-	if err != nil {
-		ctx.Error(http.StatusInternalServerError, "RenameBranch", err)
-		return
-	}
-	if msg != "" {
-		ctx.Error(http.StatusUnprocessableEntity, "", msg)
-		return
+	branchName := opt.Name
+	if branchName != "" {
+		msg, err := repo_service.RenameBranch(ctx, repo, ctx.Doer, ctx.Repo.GitRepo, oldName, branchName)
+		if err != nil {
+			ctx.Error(http.StatusInternalServerError, "RenameBranch", err)
+			return
+		}
+		if msg == "target_exist" {
+			ctx.Error(http.StatusUnprocessableEntity, "", "Cannot rename a branch using the same name or rename to a branch that already exists.")
+			return
+		}
+		if msg == "from_not_exist" {
+			ctx.Error(http.StatusUnprocessableEntity, "", "Branch doesn't exist.")
+			return
+		}
+	} else {
+		branchName = oldName
 	}
 
-	branch, err := ctx.Repo.GitRepo.GetBranch(opt.NewName)
+	branch, err := ctx.Repo.GitRepo.GetBranch(branchName)
 	if err != nil {
 		ctx.Error(http.StatusInternalServerError, "GetBranch", err)
 		return
@@ -471,13 +486,13 @@ func RenameBranch(ctx *context.APIContext) {
 		return
 	}
 
-	br, err := convert.ToBranch(ctx, repo, opt.NewName, commit, pb, ctx.Doer, ctx.Repo.IsAdmin())
+	br, err := convert.ToBranch(ctx, repo, branch.Name, commit, pb, ctx.Doer, ctx.Repo.IsAdmin())
 	if err != nil {
 		ctx.Error(http.StatusInternalServerError, "convert.ToBranch", err)
 		return
 	}
 
-	ctx.JSON(http.StatusCreated, br)
+	ctx.JSON(http.StatusOK, br)
 }
 
 // GetBranchProtection gets a branch protection

routers/api/v1/swagger/options.go

@@ -90,7 +90,7 @@ type swaggerParameterBodies struct {
 	// in:body
 	EditRepoOption api.EditRepoOption
 	// in:body
-	RenameBranchReopOption api.RenameBranchRepoOption
+	UpdateBranchRepoOption api.UpdateBranchRepoOption
 	// in:body
 	TransferRepoOption api.TransferRepoOption
 	// in:body