mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-12 01:01:11 +03:00
2848c5eb8f
* use numbers and not http.Status___ enum
* fix test
* add many missing swagger responses
* code format
* Deletion Sould return 204 ...
* error handling improvements
* if special error type ... then add it to swagger too
* one smal nit
* invalidTopicsError is []string
* valid swagger specification 2.0
- if you add responses swagger can tell you if you do it right 👍
* use ctx.InternalServerError
* Revert "use numbers and not http.Status___ enum"
This reverts commit b1ff386e24.
* use http.Status* enum everywhere
302 lines
8 KiB
Go
302 lines
8 KiB
Go
// Copyright 2017 Gitea. 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"
|
|
"net/http"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/repofiles"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
)
|
|
|
|
// NewCommitStatus creates a new CommitStatus
|
|
func NewCommitStatus(ctx *context.APIContext, form api.CreateStatusOption) {
|
|
// swagger:operation POST /repos/{owner}/{repo}/statuses/{sha} repository repoCreateStatus
|
|
// ---
|
|
// summary: Create a commit status
|
|
// 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: sha
|
|
// in: path
|
|
// description: sha of the commit
|
|
// type: string
|
|
// required: true
|
|
// - name: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/CreateStatusOption"
|
|
// responses:
|
|
// "201":
|
|
// "$ref": "#/responses/Status"
|
|
// "400":
|
|
// "$ref": "#/responses/error"
|
|
|
|
sha := ctx.Params("sha")
|
|
if len(sha) == 0 {
|
|
ctx.Error(http.StatusBadRequest, "sha not given", nil)
|
|
return
|
|
}
|
|
status := &models.CommitStatus{
|
|
State: models.CommitStatusState(form.State),
|
|
TargetURL: form.TargetURL,
|
|
Description: form.Description,
|
|
Context: form.Context,
|
|
}
|
|
if err := repofiles.CreateCommitStatus(ctx.Repo.Repository, ctx.User, sha, status); err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "CreateCommitStatus", err)
|
|
return
|
|
}
|
|
|
|
ctx.JSON(http.StatusCreated, status.APIFormat())
|
|
}
|
|
|
|
// GetCommitStatuses returns all statuses for any given commit hash
|
|
func GetCommitStatuses(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/statuses/{sha} repository repoListStatuses
|
|
// ---
|
|
// summary: Get a commit's statuses
|
|
// 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: sha
|
|
// in: path
|
|
// description: sha of the commit
|
|
// type: string
|
|
// required: true
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results
|
|
// type: integer
|
|
// required: false
|
|
// - name: sort
|
|
// in: query
|
|
// description: type of sort
|
|
// type: string
|
|
// enum: [oldest, recentupdate, leastupdate, leastindex, highestindex]
|
|
// required: false
|
|
// - name: state
|
|
// in: query
|
|
// description: type of state
|
|
// type: string
|
|
// enum: [pending, success, error, failure, warning]
|
|
// required: false
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/StatusList"
|
|
// "400":
|
|
// "$ref": "#/responses/error"
|
|
|
|
getCommitStatuses(ctx, ctx.Params("sha"))
|
|
}
|
|
|
|
// GetCommitStatusesByRef returns all statuses for any given commit ref
|
|
func GetCommitStatusesByRef(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/commits/{ref}/statuses repository repoListStatusesByRef
|
|
// ---
|
|
// summary: Get a commit's statuses, by branch/tag/commit reference
|
|
// 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: ref
|
|
// in: path
|
|
// description: name of branch/tag/commit
|
|
// type: string
|
|
// required: true
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results
|
|
// type: integer
|
|
// required: false
|
|
// - name: sort
|
|
// in: query
|
|
// description: type of sort
|
|
// type: string
|
|
// enum: [oldest, recentupdate, leastupdate, leastindex, highestindex]
|
|
// required: false
|
|
// - name: state
|
|
// in: query
|
|
// description: type of state
|
|
// type: string
|
|
// enum: [pending, success, error, failure, warning]
|
|
// required: false
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/StatusList"
|
|
// "400":
|
|
// "$ref": "#/responses/error"
|
|
|
|
filter := ctx.Params("ref")
|
|
if len(filter) == 0 {
|
|
ctx.Error(http.StatusBadRequest, "ref not given", nil)
|
|
return
|
|
}
|
|
|
|
for _, reftype := range []string{"heads", "tags"} { //Search branches and tags
|
|
refSHA, lastMethodName, err := searchRefCommitByType(ctx, reftype, filter)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, lastMethodName, err)
|
|
return
|
|
}
|
|
if refSHA != "" {
|
|
filter = refSHA
|
|
break
|
|
}
|
|
|
|
}
|
|
|
|
getCommitStatuses(ctx, filter) //By default filter is maybe the raw SHA
|
|
}
|
|
|
|
func searchRefCommitByType(ctx *context.APIContext, refType, filter string) (string, string, error) {
|
|
refs, lastMethodName, err := getGitRefs(ctx, refType+"/"+filter) //Search by type
|
|
if err != nil {
|
|
return "", lastMethodName, err
|
|
}
|
|
if len(refs) > 0 {
|
|
return refs[0].Object.String(), "", nil //Return found SHA
|
|
}
|
|
return "", "", nil
|
|
}
|
|
|
|
func getCommitStatuses(ctx *context.APIContext, sha string) {
|
|
if len(sha) == 0 {
|
|
ctx.Error(http.StatusBadRequest, "ref/sha not given", nil)
|
|
return
|
|
}
|
|
repo := ctx.Repo.Repository
|
|
|
|
statuses, _, err := models.GetCommitStatuses(repo, sha, &models.CommitStatusOptions{
|
|
Page: ctx.QueryInt("page"),
|
|
SortType: ctx.QueryTrim("sort"),
|
|
State: ctx.QueryTrim("state"),
|
|
})
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "GetCommitStatuses", fmt.Errorf("GetCommitStatuses[%s, %s, %d]: %v", repo.FullName(), sha, ctx.QueryInt("page"), err))
|
|
return
|
|
}
|
|
|
|
apiStatuses := make([]*api.Status, 0, len(statuses))
|
|
for _, status := range statuses {
|
|
apiStatuses = append(apiStatuses, status.APIFormat())
|
|
}
|
|
|
|
ctx.JSON(http.StatusOK, apiStatuses)
|
|
}
|
|
|
|
type combinedCommitStatus struct {
|
|
State models.CommitStatusState `json:"state"`
|
|
SHA string `json:"sha"`
|
|
TotalCount int `json:"total_count"`
|
|
Statuses []*api.Status `json:"statuses"`
|
|
Repo *api.Repository `json:"repository"`
|
|
CommitURL string `json:"commit_url"`
|
|
URL string `json:"url"`
|
|
}
|
|
|
|
// GetCombinedCommitStatusByRef returns the combined status for any given commit hash
|
|
func GetCombinedCommitStatusByRef(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/commits/{ref}/statuses repository repoGetCombinedStatusByRef
|
|
// ---
|
|
// summary: Get a commit's combined status, by branch/tag/commit reference
|
|
// 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: ref
|
|
// in: path
|
|
// description: name of branch/tag/commit
|
|
// type: string
|
|
// required: true
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results
|
|
// type: integer
|
|
// required: false
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/Status"
|
|
// "400":
|
|
// "$ref": "#/responses/error"
|
|
|
|
sha := ctx.Params("ref")
|
|
if len(sha) == 0 {
|
|
ctx.Error(http.StatusBadRequest, "ref/sha not given", nil)
|
|
return
|
|
}
|
|
repo := ctx.Repo.Repository
|
|
|
|
page := ctx.QueryInt("page")
|
|
|
|
statuses, err := models.GetLatestCommitStatus(repo, sha, page)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "GetLatestCommitStatus", fmt.Errorf("GetLatestCommitStatus[%s, %s, %d]: %v", repo.FullName(), sha, page, err))
|
|
return
|
|
}
|
|
|
|
if len(statuses) == 0 {
|
|
ctx.Status(http.StatusOK)
|
|
return
|
|
}
|
|
|
|
retStatus := &combinedCommitStatus{
|
|
SHA: sha,
|
|
TotalCount: len(statuses),
|
|
Repo: repo.APIFormat(ctx.Repo.AccessMode),
|
|
URL: "",
|
|
}
|
|
|
|
retStatus.Statuses = make([]*api.Status, 0, len(statuses))
|
|
for _, status := range statuses {
|
|
retStatus.Statuses = append(retStatus.Statuses, status.APIFormat())
|
|
if status.State.IsWorseThan(retStatus.State) {
|
|
retStatus.State = status.State
|
|
}
|
|
}
|
|
|
|
ctx.JSON(http.StatusOK, retStatus)
|
|
}
|