mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-27 09:54:15 -05:00
43f9233914
* Fix Swagger JSON.
Remove unnecessary schema references for the forbidden and empty responses
Signed-off-by: Andrew Thornton <art27@cantab.net>
* Fix swagger API for CreateAccessToken
* Fix admin create org swagger
* Fix swagger for adminCreateRepo
* More swagger fixes
Set int64 format for those which are int64
Some more form fixes
* Fix swagger description of GET /repos/{owner}/{repo}/pulls
366 lines
9.2 KiB
Go
366 lines
9.2 KiB
Go
// Copyright 2015 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 (
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/notification"
|
|
|
|
api "code.gitea.io/sdk/gitea"
|
|
)
|
|
|
|
// ListIssueComments list all the comments of an issue
|
|
func ListIssueComments(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/issues/{index}/comments issue issueGetComments
|
|
// ---
|
|
// summary: List all comments on an issue
|
|
// 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: since
|
|
// in: query
|
|
// description: if provided, only comments updated since the specified time are returned.
|
|
// type: string
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/CommentList"
|
|
var since time.Time
|
|
if len(ctx.Query("since")) > 0 {
|
|
since, _ = time.Parse(time.RFC3339, ctx.Query("since"))
|
|
}
|
|
|
|
// comments,err:=models.GetCommentsByIssueIDSince(, since)
|
|
issue, err := models.GetRawIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
|
|
if err != nil {
|
|
ctx.Error(500, "GetRawIssueByIndex", err)
|
|
return
|
|
}
|
|
|
|
comments, err := models.FindComments(models.FindCommentsOptions{
|
|
IssueID: issue.ID,
|
|
Since: since.Unix(),
|
|
Type: models.CommentTypeComment,
|
|
})
|
|
if err != nil {
|
|
ctx.Error(500, "GetCommentsByIssueIDSince", err)
|
|
return
|
|
}
|
|
|
|
apiComments := make([]*api.Comment, len(comments))
|
|
for i := range comments {
|
|
apiComments[i] = comments[i].APIFormat()
|
|
}
|
|
ctx.JSON(200, &apiComments)
|
|
}
|
|
|
|
// ListRepoIssueComments returns all issue-comments for a repo
|
|
func ListRepoIssueComments(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/issues/comments issue issueGetRepoComments
|
|
// ---
|
|
// summary: List all comments in a repository
|
|
// 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: since
|
|
// in: query
|
|
// description: if provided, only comments updated since the provided time are returned.
|
|
// type: string
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/CommentList"
|
|
var since time.Time
|
|
if len(ctx.Query("since")) > 0 {
|
|
since, _ = time.Parse(time.RFC3339, ctx.Query("since"))
|
|
}
|
|
|
|
comments, err := models.FindComments(models.FindCommentsOptions{
|
|
RepoID: ctx.Repo.Repository.ID,
|
|
Since: since.Unix(),
|
|
Type: models.CommentTypeComment,
|
|
})
|
|
if err != nil {
|
|
ctx.Error(500, "GetCommentsByRepoIDSince", err)
|
|
return
|
|
}
|
|
|
|
apiComments := make([]*api.Comment, len(comments))
|
|
for i := range comments {
|
|
apiComments[i] = comments[i].APIFormat()
|
|
}
|
|
ctx.JSON(200, &apiComments)
|
|
}
|
|
|
|
// CreateIssueComment create a comment for an issue
|
|
func CreateIssueComment(ctx *context.APIContext, form api.CreateIssueCommentOption) {
|
|
// swagger:operation POST /repos/{owner}/{repo}/issues/{index}/comments issue issueCreateComment
|
|
// ---
|
|
// summary: Add a comment to 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/CreateIssueCommentOption"
|
|
// responses:
|
|
// "201":
|
|
// "$ref": "#/responses/Comment"
|
|
issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
|
|
if err != nil {
|
|
ctx.Error(500, "GetIssueByIndex", err)
|
|
return
|
|
}
|
|
|
|
comment, err := models.CreateIssueComment(ctx.User, ctx.Repo.Repository, issue, form.Body, nil)
|
|
if err != nil {
|
|
ctx.Error(500, "CreateIssueComment", err)
|
|
return
|
|
}
|
|
|
|
notification.NotifyCreateIssueComment(ctx.User, ctx.Repo.Repository, issue, comment)
|
|
|
|
ctx.JSON(201, comment.APIFormat())
|
|
}
|
|
|
|
// EditIssueComment modify a comment of an issue
|
|
func EditIssueComment(ctx *context.APIContext, form api.EditIssueCommentOption) {
|
|
// swagger:operation PATCH /repos/{owner}/{repo}/issues/comments/{id} issue issueEditComment
|
|
// ---
|
|
// summary: Edit a comment
|
|
// 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 comment to edit
|
|
// type: integer
|
|
// format: int64
|
|
// required: true
|
|
// - name: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/EditIssueCommentOption"
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/Comment"
|
|
editIssueComment(ctx, form)
|
|
}
|
|
|
|
// EditIssueCommentDeprecated modify a comment of an issue
|
|
func EditIssueCommentDeprecated(ctx *context.APIContext, form api.EditIssueCommentOption) {
|
|
// swagger:operation PATCH /repos/{owner}/{repo}/issues/{index}/comments/{id} issue issueEditCommentDeprecated
|
|
// ---
|
|
// summary: Edit a comment
|
|
// deprecated: true
|
|
// 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: this parameter is ignored
|
|
// type: integer
|
|
// required: true
|
|
// - name: id
|
|
// in: path
|
|
// description: id of the comment to edit
|
|
// type: integer
|
|
// format: int64
|
|
// required: true
|
|
// - name: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/EditIssueCommentOption"
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/Comment"
|
|
editIssueComment(ctx, form)
|
|
}
|
|
|
|
func editIssueComment(ctx *context.APIContext, form api.EditIssueCommentOption) {
|
|
comment, err := models.GetCommentByID(ctx.ParamsInt64(":id"))
|
|
if err != nil {
|
|
if models.IsErrCommentNotExist(err) {
|
|
ctx.Error(404, "GetCommentByID", err)
|
|
} else {
|
|
ctx.Error(500, "GetCommentByID", err)
|
|
}
|
|
return
|
|
}
|
|
|
|
if !ctx.IsSigned || (ctx.User.ID != comment.PosterID && !ctx.Repo.IsAdmin()) {
|
|
ctx.Status(403)
|
|
return
|
|
} else if comment.Type != models.CommentTypeComment {
|
|
ctx.Status(204)
|
|
return
|
|
}
|
|
|
|
oldContent := comment.Content
|
|
comment.Content = form.Body
|
|
if err := models.UpdateComment(ctx.User, comment, oldContent); err != nil {
|
|
ctx.Error(500, "UpdateComment", err)
|
|
return
|
|
}
|
|
ctx.JSON(200, comment.APIFormat())
|
|
}
|
|
|
|
// DeleteIssueComment delete a comment from an issue
|
|
func DeleteIssueComment(ctx *context.APIContext) {
|
|
// swagger:operation DELETE /repos/{owner}/{repo}/issues/comments/{id} issue issueDeleteComment
|
|
// ---
|
|
// summary: Delete a comment
|
|
// 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 comment to delete
|
|
// type: integer
|
|
// format: int64
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
deleteIssueComment(ctx)
|
|
}
|
|
|
|
// DeleteIssueCommentDeprecated delete a comment from an issue
|
|
func DeleteIssueCommentDeprecated(ctx *context.APIContext) {
|
|
// swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/comments/{id} issue issueDeleteCommentDeprecated
|
|
// ---
|
|
// summary: Delete a comment
|
|
// deprecated: true
|
|
// 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: this parameter is ignored
|
|
// type: integer
|
|
// required: true
|
|
// - name: id
|
|
// in: path
|
|
// description: id of comment to delete
|
|
// type: integer
|
|
// format: int64
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
deleteIssueComment(ctx)
|
|
}
|
|
|
|
func deleteIssueComment(ctx *context.APIContext) {
|
|
comment, err := models.GetCommentByID(ctx.ParamsInt64(":id"))
|
|
if err != nil {
|
|
if models.IsErrCommentNotExist(err) {
|
|
ctx.Error(404, "GetCommentByID", err)
|
|
} else {
|
|
ctx.Error(500, "GetCommentByID", err)
|
|
}
|
|
return
|
|
}
|
|
|
|
if !ctx.IsSigned || (ctx.User.ID != comment.PosterID && !ctx.Repo.IsAdmin()) {
|
|
ctx.Status(403)
|
|
return
|
|
} else if comment.Type != models.CommentTypeComment {
|
|
ctx.Status(204)
|
|
return
|
|
}
|
|
|
|
if err = models.DeleteComment(ctx.User, comment); err != nil {
|
|
ctx.Error(500, "DeleteCommentByID", err)
|
|
return
|
|
}
|
|
ctx.Status(204)
|
|
}
|