Simplify mirror repository API logic (#30963) (#31009)

Backport #30963 by wxiaoguang

Fix #30921

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

diff --git a/modules/structs/repo.go b/modules/structs/repo.go
index bc8eb0b756973bf01aae5668f0256b6753c78d1f..1fe826cf894b9ee82ee947294f7a6d0bd5a79360 100644 (file)
--- a/modules/structs/repo.go
+++ b/modules/structs/repo.go
@@ -217,7 +217,7 @@ type EditRepoOption struct {
        Archived *bool `json:"archived,omitempty"`
        // set to a string like `8h30m0s` to set the mirror interval time
        MirrorInterval *string `json:"mirror_interval,omitempty"`
-       // enable prune - remove obsolete remote-tracking references
+       // enable prune - remove obsolete remote-tracking references when mirroring
        EnablePrune *bool `json:"enable_prune,omitempty"`
 }
 

diff --git a/routers/api/v1/repo/repo.go b/routers/api/v1/repo/repo.go
index 7f35a7fe4176b8d4c5a4433ae10a4575d1afa56f..e759142938168f8a736f824ab4c028531ea64668 100644 (file)
--- a/routers/api/v1/repo/repo.go
+++ b/routers/api/v1/repo/repo.go
@@ -1062,16 +1062,10 @@ func updateRepoArchivedState(ctx *context.APIContext, opts api.EditRepoOption) e
 func updateMirror(ctx *context.APIContext, opts api.EditRepoOption) error {
        repo := ctx.Repo.Repository
 
-       // only update mirror if interval or enable prune are provided
-       if opts.MirrorInterval == nil && opts.EnablePrune == nil {
-               return nil
-       }
-
-       // these values only make sense if the repo is a mirror
+       // Skip this update if the repo is not a mirror, do not return error.
+       // Because reporting errors only makes the logic more complex&fragile, it doesn't really help end users.
        if !repo.IsMirror {
-               err := fmt.Errorf("repo is not a mirror, can not change mirror interval")
-               ctx.Error(http.StatusUnprocessableEntity, err.Error(), err)
-               return err
+               return nil
        }
 
        // get the mirror from the repo

diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index 1c23c72ac23c651e762e758fb7629f9c354f5abd..764a13063d54e88205ba9e3bc5b753c8dcd17e89 100644 (file)
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@@ -20610,7 +20610,7 @@
           "x-go-name": "Description"
         },
         "enable_prune": {
-          "description": "enable prune - remove obsolete remote-tracking references",
+          "description": "enable prune - remove obsolete remote-tracking references when mirroring",
           "type": "boolean",
           "x-go-name": "EnablePrune"
         },