mirror of
https://github.com/go-gitea/gitea
synced 2024-11-18 16:01:36 +01:00
f26f4a7e01
* Update swagger documentation Add docs for missing endpoints Add documentation for request parameters Make parameter naming consistent Fix response documentation * Restore delete comments
295 lines
7.1 KiB
Go
295 lines
7.1 KiB
Go
// Copyright 2016 The Gogs Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package repo
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
api "code.gitea.io/sdk/gitea"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/modules/util"
|
|
)
|
|
|
|
// ListIssues list the issues of a repository
|
|
func ListIssues(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/issues issue issueListIssues
|
|
// ---
|
|
// summary: List a repository's issues
|
|
// 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: state
|
|
// in: query
|
|
// description: whether issue is open or closed
|
|
// type: string
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of requested issues
|
|
// type: integer
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/IssueList"
|
|
var isClosed util.OptionalBool
|
|
switch ctx.Query("state") {
|
|
case "closed":
|
|
isClosed = util.OptionalBoolTrue
|
|
case "all":
|
|
isClosed = util.OptionalBoolNone
|
|
default:
|
|
isClosed = util.OptionalBoolFalse
|
|
}
|
|
|
|
issues, err := models.Issues(&models.IssuesOptions{
|
|
RepoID: ctx.Repo.Repository.ID,
|
|
Page: ctx.QueryInt("page"),
|
|
PageSize: setting.UI.IssuePagingNum,
|
|
IsClosed: isClosed,
|
|
})
|
|
if err != nil {
|
|
ctx.Error(500, "Issues", err)
|
|
return
|
|
}
|
|
|
|
apiIssues := make([]*api.Issue, len(issues))
|
|
for i := range issues {
|
|
apiIssues[i] = issues[i].APIFormat()
|
|
}
|
|
|
|
ctx.SetLinkHeader(ctx.Repo.Repository.NumIssues, setting.UI.IssuePagingNum)
|
|
ctx.JSON(200, &apiIssues)
|
|
}
|
|
|
|
// GetIssue get an issue of a repository
|
|
func GetIssue(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/issues/{id} issue issueGetIssue
|
|
// ---
|
|
// summary: Get an issue by id
|
|
// 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: id
|
|
// in: path
|
|
// description: id of the issue to get
|
|
// type: integer
|
|
// required: true
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/Issue"
|
|
issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
|
|
if err != nil {
|
|
if models.IsErrIssueNotExist(err) {
|
|
ctx.Status(404)
|
|
} else {
|
|
ctx.Error(500, "GetIssueByIndex", err)
|
|
}
|
|
return
|
|
}
|
|
ctx.JSON(200, issue.APIFormat())
|
|
}
|
|
|
|
// CreateIssue create an issue of a repository
|
|
func CreateIssue(ctx *context.APIContext, form api.CreateIssueOption) {
|
|
// swagger:operation POST /repos/{owner}/{repo}/issues issue issueCreateIssue
|
|
// ---
|
|
// summary: Create 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: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/CreateIssueOption"
|
|
// responses:
|
|
// "201":
|
|
// "$ref": "#/responses/Issue"
|
|
issue := &models.Issue{
|
|
RepoID: ctx.Repo.Repository.ID,
|
|
Title: form.Title,
|
|
PosterID: ctx.User.ID,
|
|
Poster: ctx.User,
|
|
Content: form.Body,
|
|
}
|
|
|
|
if ctx.Repo.IsWriter() {
|
|
if len(form.Assignee) > 0 {
|
|
assignee, err := models.GetUserByName(form.Assignee)
|
|
if err != nil {
|
|
if models.IsErrUserNotExist(err) {
|
|
ctx.Error(422, "", fmt.Sprintf("Assignee does not exist: [name: %s]", form.Assignee))
|
|
} else {
|
|
ctx.Error(500, "GetUserByName", err)
|
|
}
|
|
return
|
|
}
|
|
issue.AssigneeID = assignee.ID
|
|
}
|
|
issue.MilestoneID = form.Milestone
|
|
} else {
|
|
form.Labels = nil
|
|
}
|
|
|
|
if err := models.NewIssue(ctx.Repo.Repository, issue, form.Labels, nil); err != nil {
|
|
ctx.Error(500, "NewIssue", err)
|
|
return
|
|
}
|
|
|
|
if form.Closed {
|
|
if err := issue.ChangeStatus(ctx.User, ctx.Repo.Repository, true); err != nil {
|
|
ctx.Error(500, "ChangeStatus", err)
|
|
return
|
|
}
|
|
}
|
|
|
|
// Refetch from database to assign some automatic values
|
|
var err error
|
|
issue, err = models.GetIssueByID(issue.ID)
|
|
if err != nil {
|
|
ctx.Error(500, "GetIssueByID", err)
|
|
return
|
|
}
|
|
ctx.JSON(201, issue.APIFormat())
|
|
}
|
|
|
|
// EditIssue modify an issue of a repository
|
|
func EditIssue(ctx *context.APIContext, form api.EditIssueOption) {
|
|
// swagger:operation PATCH /repos/{owner}/{repo}/issues/{id} issue issueEditIssue
|
|
// ---
|
|
// summary: Edit 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: id
|
|
// in: path
|
|
// description: id of the issue to edit
|
|
// type: integer
|
|
// required: true
|
|
// - name: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/EditIssueOption"
|
|
// responses:
|
|
// "201":
|
|
// "$ref": "#/responses/Issue"
|
|
issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
|
|
if err != nil {
|
|
if models.IsErrIssueNotExist(err) {
|
|
ctx.Status(404)
|
|
} else {
|
|
ctx.Error(500, "GetIssueByIndex", err)
|
|
}
|
|
return
|
|
}
|
|
|
|
if !issue.IsPoster(ctx.User.ID) && !ctx.Repo.IsWriter() {
|
|
ctx.Status(403)
|
|
return
|
|
}
|
|
|
|
if len(form.Title) > 0 {
|
|
issue.Title = form.Title
|
|
}
|
|
if form.Body != nil {
|
|
issue.Content = *form.Body
|
|
}
|
|
|
|
if ctx.Repo.IsWriter() && form.Assignee != nil &&
|
|
(issue.Assignee == nil || issue.Assignee.LowerName != strings.ToLower(*form.Assignee)) {
|
|
if len(*form.Assignee) == 0 {
|
|
issue.AssigneeID = 0
|
|
} else {
|
|
assignee, err := models.GetUserByName(*form.Assignee)
|
|
if err != nil {
|
|
if models.IsErrUserNotExist(err) {
|
|
ctx.Error(422, "", fmt.Sprintf("assignee does not exist: [name: %s]", *form.Assignee))
|
|
} else {
|
|
ctx.Error(500, "GetUserByName", err)
|
|
}
|
|
return
|
|
}
|
|
issue.AssigneeID = assignee.ID
|
|
}
|
|
|
|
if err = models.UpdateIssueUserByAssignee(issue); err != nil {
|
|
ctx.Error(500, "UpdateIssueUserByAssignee", err)
|
|
return
|
|
}
|
|
}
|
|
if ctx.Repo.IsWriter() && form.Milestone != nil &&
|
|
issue.MilestoneID != *form.Milestone {
|
|
oldMilestoneID := issue.MilestoneID
|
|
issue.MilestoneID = *form.Milestone
|
|
if err = models.ChangeMilestoneAssign(issue, ctx.User, oldMilestoneID); err != nil {
|
|
ctx.Error(500, "ChangeMilestoneAssign", err)
|
|
return
|
|
}
|
|
}
|
|
|
|
if err = models.UpdateIssue(issue); err != nil {
|
|
ctx.Error(500, "UpdateIssue", err)
|
|
return
|
|
}
|
|
if form.State != nil {
|
|
if err = issue.ChangeStatus(ctx.User, ctx.Repo.Repository, api.StateClosed == api.StateType(*form.State)); err != nil {
|
|
ctx.Error(500, "ChangeStatus", err)
|
|
return
|
|
}
|
|
}
|
|
|
|
// Refetch from database to assign some automatic values
|
|
issue, err = models.GetIssueByID(issue.ID)
|
|
if err != nil {
|
|
ctx.Error(500, "GetIssueByID", err)
|
|
return
|
|
}
|
|
ctx.JSON(201, issue.APIFormat())
|
|
}
|