add API endpoints to update/delete protected branch #7093

quantonganh · 2019-05-31T10:47:29Z

techknowlogick · 2019-05-31T20:38:19Z

Thanks for PR :) The CI is currently failing due to needing a rebase on the latest commit of master.

I think additional routes for the API are needing for these methods, as well as swagger definitions.

codecov-io · 2019-06-03T05:06:48Z

Codecov Report

Merging #7093 into master will decrease coverage by 0.67%.
The diff coverage is 6.91%.

@@            Coverage Diff             @@
##           master    #7093      +/-   ##
==========================================
- Coverage    41.8%   41.12%   -0.68%     
==========================================
  Files         496      469      -27     
  Lines       65586    63604    -1982     
==========================================
- Hits        27416    26159    -1257     
+ Misses      34654    34027     -627     
+ Partials     3516     3418      -98

Impacted Files	Coverage Δ
routers/api/v1/api.go	`71.53% <100%> (-1.47%)`	⬇️
routers/api/v1/convert/convert.go	`84.03% <100%> (+2.62%)`	⬆️
routers/api/v1/repo/branch.go	`14.74% <2.23%> (-29.01%)`	⬇️
modules/upload/filetype.go	`0% <0%> (-72.23%)`	⬇️
routers/api/v1/repo/status.go	`21.02% <0%> (-23.52%)`	⬇️
models/repo_unit.go	`64.91% <0%> (-21.06%)`	⬇️
modules/setting/git.go	`46.15% <0%> (-19.24%)`	⬇️
modules/git/notes.go	`40% <0%> (-17.15%)`	⬇️
routers/api/v1/org/team.go	`25.58% <0%> (-12.61%)`	⬇️
models/topic.go	`54.7% <0%> (-11.97%)`	⬇️
... and 218 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f92a0b6...4afd393. Read the comment docs.

quantonganh · 2019-06-11T06:43:29Z

I think additional routes for the API are needing for these methods, as well as swagger definitions.

Routes and swagger definitions have been added.
@techknowlogick Could you please take a review?

davidsvantesson · 2019-08-27T09:23:55Z

routers/api/v1/repo/branch.go

+	protectBranch, err := models.GetProtectedBranchBy(ctx.Repo.Repository.ID, ctx.Params(":branch"))
+	if err != nil {
+		if !git.IsErrBranchNotExist(err) {
+			ctx.Error(http.StatusInternalServerError, "GetProtectedBranchBy", err)
 			return
 		}


Xorm will not give an error if there is no row in the database, but an empty object.
You need to handle:

If there is no protected branch, but the branch exist (create protectBranch with default values / protection:false )

If the branch doesn't exist. (404)

davidsvantesson · 2019-08-27T09:24:11Z

routers/api/v1/repo/branch.go

+		if !git.IsErrBranchNotExist(err) {
+			ctx.Error(http.StatusInternalServerError, "GetProtectedBranchBy", err)
+			return
+		}


Same problem as above with xorm.
If the protected branch does not exist, you need to check if the branch exist (or give 404)

davidsvantesson · 2019-08-27T09:25:00Z

routers/api/v1/repo/branch.go

+		if !git.IsErrBranchNotExist(err) {
+			ctx.Error(http.StatusInternalServerError, "GetProtectedBranchBy", err)
+			return
+		}


Same problem as above with xorm. Maybe ok to give 404 directly if protected branch doesn't exist.

davidsvantesson · 2019-08-27T22:14:08Z

templates/swagger/v1_json.tmpl

@@ -9115,6 +9243,44 @@
      },
      "x-go-package": "code.gitea.io/gitea/modules/structs"
    },
+    "ProtectBranchForm": {


It's a bit problematic to reuse the same structure for API from documentation point of view. How do I know the format of XWhiteListTeams and XWhiteListUsers? Preferably they should be arrays. At least they should change name to XWhiteListTeamIDs and XWhiteListUserIDs

lunny · 2019-09-27T14:04:41Z

modules/structs/repo_branch.go

-	Commit *PayloadCommit `json:"commit"`
+	Name      string         `json:"name"`
+	Commit    *PayloadCommit `json:"commit"`
+	Protected bool           `json:"protected"`
 }


I think we need more details about the branch protection settings but not only a bool.

davidsvantesson · 2019-12-12T06:54:33Z

I think this one can be moved to 1.12, no chance for this release. I hope either this one or my new PR can get into next release.

stale · 2020-02-10T06:57:58Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs during the next 2 months. Thank you for your contributions.

davidsvantesson · 2020-02-13T10:27:29Z

This one can be closed.

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label May 31, 2019

quantonganh force-pushed the fix-2922 branch from a658886 to b04a7e1 Compare June 3, 2019 04:36

lunny added the pr/wip This PR is not ready for review label Jun 3, 2019

quantonganh force-pushed the fix-2922 branch 3 times, most recently from 85243c9 to 9c4976a Compare June 11, 2019 05:43

techknowlogick added type/feature Completely new functionality. Can only be merged if feature freeze is not active. and removed pr/wip This PR is not ready for review labels Jun 11, 2019

techknowlogick added this to the 1.10.0 milestone Jun 11, 2019

quantonganh added 2 commits July 8, 2019 15:06

add API endpoints to get/update/delete protected branch

b83b17e

make generate-swagger

03a2435

quantonganh force-pushed the fix-2922 branch from 9c4976a to 03a2435 Compare July 8, 2019 08:06

davidsvantesson suggested changes Aug 27, 2019

View reviewed changes

davidsvantesson reviewed Aug 27, 2019

View reviewed changes

guillep2k mentioned this pull request Sep 11, 2019

[API] add protected info to /api/v1/repos/{owner}/{repo}/branches #8154

Closed

lunny reviewed Sep 27, 2019

View reviewed changes

Merge branch 'master' into fix-2922

4afd393

techknowlogick modified the milestones: 1.10.0, 1.11.0 Oct 4, 2019

davidsvantesson mentioned this pull request Dec 10, 2019

Add API branch protection endpoint #9311

Merged

techknowlogick modified the milestones: 1.11.0, 1.12.0 Dec 12, 2019

stale bot added the issue/stale label Feb 10, 2020

stale bot removed the issue/stale label Feb 13, 2020

lunny closed this Feb 13, 2020

lunny removed this from the 1.12.0 milestone Feb 13, 2020

go-gitea locked and limited conversation to collaborators Nov 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add API endpoints to update/delete protected branch #7093

add API endpoints to update/delete protected branch #7093

quantonganh commented May 31, 2019

techknowlogick commented May 31, 2019

codecov-io commented Jun 3, 2019 •

edited

Loading

quantonganh commented Jun 11, 2019

davidsvantesson Aug 27, 2019 •

edited

Loading

davidsvantesson Aug 27, 2019 •

edited

Loading

davidsvantesson Aug 27, 2019 •

edited

Loading

davidsvantesson Aug 27, 2019

lunny Sep 27, 2019

davidsvantesson commented Dec 12, 2019

stale bot commented Feb 10, 2020

davidsvantesson commented Feb 13, 2020

add API endpoints to update/delete protected branch #7093

add API endpoints to update/delete protected branch #7093

Conversation

quantonganh commented May 31, 2019

techknowlogick commented May 31, 2019

codecov-io commented Jun 3, 2019 • edited Loading

Codecov Report

quantonganh commented Jun 11, 2019

davidsvantesson Aug 27, 2019 • edited Loading

Choose a reason for hiding this comment

davidsvantesson Aug 27, 2019 • edited Loading

Choose a reason for hiding this comment

davidsvantesson Aug 27, 2019 • edited Loading

Choose a reason for hiding this comment

davidsvantesson Aug 27, 2019

Choose a reason for hiding this comment

lunny Sep 27, 2019

Choose a reason for hiding this comment

davidsvantesson commented Dec 12, 2019

stale bot commented Feb 10, 2020

davidsvantesson commented Feb 13, 2020

codecov-io commented Jun 3, 2019 •

edited

Loading

davidsvantesson Aug 27, 2019 •

edited

Loading

davidsvantesson Aug 27, 2019 •

edited

Loading

davidsvantesson Aug 27, 2019 •

edited

Loading