mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-10-25 03:22:36 +00:00
f05b960494
Ticket #5676 states that the output from `make generate-swagger` is not valid according to the current [OpenAPI specification](https://swagger.io/specification/#path-item-object). In future this [may change](https://swagger.io/specification/#reference-object) but currently this has the effect that the `description` field will be ignored. Removing the description from the type definition of the offending entry will fix the invalid output and have the same end result as before, as the description would have been ignored anyway. ## Checklist ### Tests No changes to Go (except removal of comment) or Javascript code. Have added the `lint-swagger` task to the CI test run however. ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] I do not want this change to show in the release notes. - [ ] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7019 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: Sven Steinbauer <sven@unlogic.co.uk> Co-committed-by: Sven Steinbauer <sven@unlogic.co.uk>
110 lines
3.6 KiB
Go
110 lines
3.6 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package structs
|
|
|
|
import (
|
|
"time"
|
|
)
|
|
|
|
// ReviewStateType review state type
|
|
type ReviewStateType string
|
|
|
|
const (
|
|
// ReviewStateApproved pr is approved
|
|
ReviewStateApproved ReviewStateType = "APPROVED"
|
|
// ReviewStatePending pr state is pending
|
|
ReviewStatePending ReviewStateType = "PENDING"
|
|
// ReviewStateComment is a comment review
|
|
ReviewStateComment ReviewStateType = "COMMENT"
|
|
// ReviewStateRequestChanges changes for pr are requested
|
|
ReviewStateRequestChanges ReviewStateType = "REQUEST_CHANGES"
|
|
// ReviewStateRequestReview review is requested from user
|
|
ReviewStateRequestReview ReviewStateType = "REQUEST_REVIEW"
|
|
// ReviewStateUnknown state of pr is unknown
|
|
ReviewStateUnknown ReviewStateType = ""
|
|
)
|
|
|
|
// PullReview represents a pull request review
|
|
type PullReview struct {
|
|
ID int64 `json:"id"`
|
|
Reviewer *User `json:"user"`
|
|
ReviewerTeam *Team `json:"team"`
|
|
State ReviewStateType `json:"state"`
|
|
Body string `json:"body"`
|
|
CommitID string `json:"commit_id"`
|
|
Stale bool `json:"stale"`
|
|
Official bool `json:"official"`
|
|
Dismissed bool `json:"dismissed"`
|
|
CodeCommentsCount int `json:"comments_count"`
|
|
// swagger:strfmt date-time
|
|
Submitted time.Time `json:"submitted_at"`
|
|
// swagger:strfmt date-time
|
|
Updated time.Time `json:"updated_at"`
|
|
|
|
HTMLURL string `json:"html_url"`
|
|
HTMLPullURL string `json:"pull_request_url"`
|
|
}
|
|
|
|
// PullReviewComment represents a comment on a pull request review
|
|
type PullReviewComment struct {
|
|
ID int64 `json:"id"`
|
|
Body string `json:"body"`
|
|
Poster *User `json:"user"`
|
|
Resolver *User `json:"resolver"`
|
|
ReviewID int64 `json:"pull_request_review_id"`
|
|
|
|
// swagger:strfmt date-time
|
|
Created time.Time `json:"created_at"`
|
|
// swagger:strfmt date-time
|
|
Updated time.Time `json:"updated_at"`
|
|
|
|
Path string `json:"path"`
|
|
CommitID string `json:"commit_id"`
|
|
OrigCommitID string `json:"original_commit_id"`
|
|
DiffHunk string `json:"diff_hunk"`
|
|
LineNum uint64 `json:"position"`
|
|
OldLineNum uint64 `json:"original_position"`
|
|
|
|
HTMLURL string `json:"html_url"`
|
|
HTMLPullURL string `json:"pull_request_url"`
|
|
}
|
|
|
|
// CreatePullReviewOptions are options to create a pull review
|
|
type CreatePullReviewOptions struct {
|
|
Event ReviewStateType `json:"event"`
|
|
Body string `json:"body"`
|
|
CommitID string `json:"commit_id"`
|
|
Comments []CreatePullReviewComment `json:"comments"`
|
|
}
|
|
|
|
// CreatePullReviewComment represent a review comment for creation api
|
|
type CreatePullReviewComment struct {
|
|
// the tree path
|
|
Path string `json:"path"`
|
|
Body string `json:"body"`
|
|
// if comment to old file line or 0
|
|
OldLineNum int64 `json:"old_position"`
|
|
// if comment to new file line or 0
|
|
NewLineNum int64 `json:"new_position"`
|
|
}
|
|
|
|
type CreatePullReviewCommentOptions CreatePullReviewComment
|
|
|
|
// SubmitPullReviewOptions are options to submit a pending pull review
|
|
type SubmitPullReviewOptions struct {
|
|
Event ReviewStateType `json:"event"`
|
|
Body string `json:"body"`
|
|
}
|
|
|
|
// DismissPullReviewOptions are options to dismiss a pull review
|
|
type DismissPullReviewOptions struct {
|
|
Message string `json:"message"`
|
|
Priors bool `json:"priors"`
|
|
}
|
|
|
|
// PullReviewRequestOptions are options to add or remove pull review requests
|
|
type PullReviewRequestOptions struct {
|
|
Reviewers []string `json:"reviewers"`
|
|
TeamReviewers []string `json:"team_reviewers"`
|
|
}
|