mirror of https://github.com/go-gitea/gitea.git
Browse Source
This pull request adds a GitHub-compatible API endpoint to lock and
unlock an issue.
The following routes exist now:
- `PUT /api/v1/repos/{owner}/{repo}/issues/{id}/lock` to lock an issue
- `DELETE /api/v1/repos/{owner}/{repo}/issues/{id}/lock` to unlock an issue
Fixes #33677
Fixes #20012
---------
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
pull/34251/head
YaFou
8 months ago
committed by
GitHub
11 changed files with 364 additions and 51 deletions
@ -0,0 +1,152 @@
@@ -0,0 +1,152 @@
|
||||
// Copyright 2025 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package repo |
||||
|
||||
import ( |
||||
"errors" |
||||
"net/http" |
||||
|
||||
issues_model "code.gitea.io/gitea/models/issues" |
||||
api "code.gitea.io/gitea/modules/structs" |
||||
"code.gitea.io/gitea/modules/web" |
||||
"code.gitea.io/gitea/services/context" |
||||
) |
||||
|
||||
// LockIssue lock an issue
|
||||
func LockIssue(ctx *context.APIContext) { |
||||
// swagger:operation PUT /repos/{owner}/{repo}/issues/{index}/lock issue issueLockIssue
|
||||
// ---
|
||||
// summary: Lock an issue
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: index
|
||||
// in: path
|
||||
// description: index of the issue
|
||||
// type: integer
|
||||
// format: int64
|
||||
// required: true
|
||||
// - name: body
|
||||
// in: body
|
||||
// schema:
|
||||
// "$ref": "#/definitions/LockIssueOption"
|
||||
// responses:
|
||||
// "204":
|
||||
// "$ref": "#/responses/empty"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
|
||||
reason := web.GetForm(ctx).(*api.LockIssueOption).Reason |
||||
issue, err := issues_model.GetIssueByIndex(ctx, ctx.Repo.Repository.ID, ctx.PathParamInt64("index")) |
||||
if err != nil { |
||||
if issues_model.IsErrIssueNotExist(err) { |
||||
ctx.APIErrorNotFound(err) |
||||
} else { |
||||
ctx.APIErrorInternal(err) |
||||
} |
||||
return |
||||
} |
||||
|
||||
if !ctx.Repo.CanWriteIssuesOrPulls(issue.IsPull) { |
||||
ctx.APIError(http.StatusForbidden, errors.New("no permission to lock this issue")) |
||||
return |
||||
} |
||||
|
||||
if !issue.IsLocked { |
||||
opt := &issues_model.IssueLockOptions{ |
||||
Doer: ctx.ContextUser, |
||||
Issue: issue, |
||||
Reason: reason, |
||||
} |
||||
|
||||
issue.Repo = ctx.Repo.Repository |
||||
err = issues_model.LockIssue(ctx, opt) |
||||
if err != nil { |
||||
ctx.APIErrorInternal(err) |
||||
return |
||||
} |
||||
} |
||||
|
||||
ctx.Status(http.StatusNoContent) |
||||
} |
||||
|
||||
// UnlockIssue unlock an issue
|
||||
func UnlockIssue(ctx *context.APIContext) { |
||||
// swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/lock issue issueUnlockIssue
|
||||
// ---
|
||||
// summary: Unlock an issue
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: index
|
||||
// in: path
|
||||
// description: index of the issue
|
||||
// type: integer
|
||||
// format: int64
|
||||
// required: true
|
||||
// responses:
|
||||
// "204":
|
||||
// "$ref": "#/responses/empty"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
|
||||
issue, err := issues_model.GetIssueByIndex(ctx, ctx.Repo.Repository.ID, ctx.PathParamInt64("index")) |
||||
if err != nil { |
||||
if issues_model.IsErrIssueNotExist(err) { |
||||
ctx.APIErrorNotFound(err) |
||||
} else { |
||||
ctx.APIErrorInternal(err) |
||||
} |
||||
return |
||||
} |
||||
|
||||
if !ctx.Repo.CanWriteIssuesOrPulls(issue.IsPull) { |
||||
ctx.APIError(http.StatusForbidden, errors.New("no permission to unlock this issue")) |
||||
return |
||||
} |
||||
|
||||
if issue.IsLocked { |
||||
opt := &issues_model.IssueLockOptions{ |
||||
Doer: ctx.ContextUser, |
||||
Issue: issue, |
||||
} |
||||
|
||||
issue.Repo = ctx.Repo.Repository |
||||
err = issues_model.UnlockIssue(ctx, opt) |
||||
if err != nil { |
||||
ctx.APIErrorInternal(err) |
||||
return |
||||
} |
||||
} |
||||
|
||||
ctx.Status(http.StatusNoContent) |
||||
} |
||||
@ -0,0 +1,74 @@
@@ -0,0 +1,74 @@
|
||||
// Copyright 2025 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package integration |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/http" |
||||
"testing" |
||||
|
||||
auth_model "code.gitea.io/gitea/models/auth" |
||||
issues_model "code.gitea.io/gitea/models/issues" |
||||
repo_model "code.gitea.io/gitea/models/repo" |
||||
"code.gitea.io/gitea/models/unittest" |
||||
user_model "code.gitea.io/gitea/models/user" |
||||
api "code.gitea.io/gitea/modules/structs" |
||||
"code.gitea.io/gitea/tests" |
||||
|
||||
"github.com/stretchr/testify/assert" |
||||
) |
||||
|
||||
func TestAPILockIssue(t *testing.T) { |
||||
defer tests.PrepareTestEnv(t)() |
||||
|
||||
t.Run("Lock", func(t *testing.T) { |
||||
issueBefore := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 1}) |
||||
assert.False(t, issueBefore.IsLocked) |
||||
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issueBefore.RepoID}) |
||||
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}) |
||||
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/%d/lock", owner.Name, repo.Name, issueBefore.Index) |
||||
|
||||
session := loginUser(t, owner.Name) |
||||
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteIssue) |
||||
|
||||
// check lock issue
|
||||
req := NewRequestWithJSON(t, "PUT", urlStr, api.LockIssueOption{Reason: "Spam"}).AddTokenAuth(token) |
||||
MakeRequest(t, req, http.StatusNoContent) |
||||
issueAfter := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 1}) |
||||
assert.True(t, issueAfter.IsLocked) |
||||
|
||||
// check with other user
|
||||
user34 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 34}) |
||||
session34 := loginUser(t, user34.Name) |
||||
token34 := getTokenForLoggedInUser(t, session34, auth_model.AccessTokenScopeAll) |
||||
req = NewRequestWithJSON(t, "PUT", urlStr, api.LockIssueOption{Reason: "Spam"}).AddTokenAuth(token34) |
||||
MakeRequest(t, req, http.StatusForbidden) |
||||
}) |
||||
|
||||
t.Run("Unlock", func(t *testing.T) { |
||||
issueBefore := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 1}) |
||||
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issueBefore.RepoID}) |
||||
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}) |
||||
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/%d/lock", owner.Name, repo.Name, issueBefore.Index) |
||||
|
||||
session := loginUser(t, owner.Name) |
||||
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteIssue) |
||||
|
||||
lockReq := NewRequestWithJSON(t, "PUT", urlStr, api.LockIssueOption{Reason: "Spam"}).AddTokenAuth(token) |
||||
MakeRequest(t, lockReq, http.StatusNoContent) |
||||
|
||||
// check unlock issue
|
||||
req := NewRequest(t, "DELETE", urlStr).AddTokenAuth(token) |
||||
MakeRequest(t, req, http.StatusNoContent) |
||||
issueAfter := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 1}) |
||||
assert.False(t, issueAfter.IsLocked) |
||||
|
||||
// check with other user
|
||||
user34 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 34}) |
||||
session34 := loginUser(t, user34.Name) |
||||
token34 := getTokenForLoggedInUser(t, session34, auth_model.AccessTokenScopeAll) |
||||
req = NewRequest(t, "DELETE", urlStr).AddTokenAuth(token34) |
||||
MakeRequest(t, req, http.StatusForbidden) |
||||
}) |
||||
} |
||||
Loading…
Reference in new issue