Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API: Added pull review read only endpoints #10005

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions modules/structs/pull_review.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Copyright 2020 The Gitea 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 structs

import (
"time"
)

// PullRequestReview represents a pull request review
type PullRequestReview struct {
ID int64 `json:"id"`
PRURL string `json:"pull_request_url"`
Reviewer *User `json:"user"`
Body string `json:"body"`
CommitID string `json:"commit_id"`
Type string `json:"type"`

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add state info too?

"state": "APPROVED",

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

o it still a draft :D - the start looks good 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about naming that state, but it was so misleading, that I've gone with type.

"state":"COMMENT"

just looks strange.

But i can rename this if wanted.

Copy link
Member

@6543 6543 Jan 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fair point ... just did a comparsion with the github api ...
and beside COMMENT, PENDING, APPROVED, REJECT could be interpreted as state ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But i can rename this if wanted.

please :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add field submitted_at?

Copy link
Contributor

@davidsvantesson davidsvantesson Feb 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stale and official can also be interesting fields (GH doesn't have them).
Also possibility to get list of only latest review of each reviewer would be good, as that is what is seen on PR page.

// swagger:strfmt date-time
Created time.Time `json:"created_at"`

// TODO: is there a way to get a URL to the review itself?
// HTMLURL string `json:"html_url"`
}

// PullRequestReviewComment represents a comment on a pull request
type PullRequestReviewComment struct {
ID int64 `json:"id"`
URL string `json:"url"`
PRURL string `json:"pull_request_url"`
ReviewID int64 `json:"pull_request_review_id"`
Path string `json:"path"`
CommitID string `json:"commit_id"`
DiffHunk string `json:"diff_hunk"`
LineNum uint64 `json:"position"`
OldLineNum uint64 `json:"original_position"`
Reviewer *User `json:"user"`
Body string `json:"body"`
}
10 changes: 9 additions & 1 deletion routers/api/v1/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ func RegisterRoutes(m *macaron.Macaron) {
bind := binding.Bind

if setting.API.EnableSwagger {
m.Get("/swagger", misc.Swagger) //Render V1 by default
m.Get("/swagger", misc.Swagger) // Render V1 by default
}

m.Group("/v1", func() {
Expand Down Expand Up @@ -773,6 +773,14 @@ func RegisterRoutes(m *macaron.Macaron) {
Patch(reqToken(), reqRepoWriter(models.UnitTypePullRequests), bind(api.EditPullRequestOption{}), repo.EditPullRequest)
m.Combo("/merge").Get(repo.IsPullRequestMerged).
Post(reqToken(), mustNotBeArchived, reqRepoWriter(models.UnitTypePullRequests), bind(auth.MergePullRequestForm{}), repo.MergePullRequest)
m.Group("/reviews", func() {
m.Combo("").Get(repo.ListPullReviews)
m.Group("/:id", func() {
m.Combo("").Get(repo.GetPullReview)
m.Combo("/comments").Get(repo.GetPullReviewComments)
})
})

})
}, mustAllowPulls, reqRepoReader(models.UnitTypeCode), context.ReferencesGitRepo(false))
m.Group("/statuses", func() {
Expand Down
Loading