mirror of
https://github.com/go-gitea/gitea.git
synced 2024-12-12 23:50:00 +08:00
aaeec2a392
Most middleware throw a 404 in case something is not found e.g. a Repo that is not existing. But most API endpoints don't include the 404 response in their documentation. This PR changes this.
301 lines
8.0 KiB
Go
301 lines
8.0 KiB
Go
// Copyright 2016 The Gogs Authors. All rights reserved.
|
|
// Copyright 2020 The Gitea Authors.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package repo
|
|
|
|
import (
|
|
"net/http"
|
|
"strconv"
|
|
"time"
|
|
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
|
"code.gitea.io/gitea/modules/context"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/timeutil"
|
|
"code.gitea.io/gitea/modules/web"
|
|
"code.gitea.io/gitea/routers/api/v1/utils"
|
|
"code.gitea.io/gitea/services/convert"
|
|
)
|
|
|
|
// ListMilestones list milestones for a repository
|
|
func ListMilestones(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/milestones issue issueGetMilestonesList
|
|
// ---
|
|
// summary: Get all of a repository's opened milestones
|
|
// 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: Milestone state, Recognized values are open, closed and all. Defaults to "open"
|
|
// type: string
|
|
// - name: name
|
|
// in: query
|
|
// description: filter by milestone name
|
|
// type: string
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results to return (1-based)
|
|
// type: integer
|
|
// - name: limit
|
|
// in: query
|
|
// description: page size of results
|
|
// type: integer
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/MilestoneList"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
milestones, total, err := issues_model.GetMilestones(issues_model.GetMilestonesOption{
|
|
ListOptions: utils.GetListOptions(ctx),
|
|
RepoID: ctx.Repo.Repository.ID,
|
|
State: api.StateType(ctx.FormString("state")),
|
|
Name: ctx.FormString("name"),
|
|
})
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "GetMilestones", err)
|
|
return
|
|
}
|
|
|
|
apiMilestones := make([]*api.Milestone, len(milestones))
|
|
for i := range milestones {
|
|
apiMilestones[i] = convert.ToAPIMilestone(milestones[i])
|
|
}
|
|
|
|
ctx.SetTotalCountHeader(total)
|
|
ctx.JSON(http.StatusOK, &apiMilestones)
|
|
}
|
|
|
|
// GetMilestone get a milestone for a repository by ID and if not available by name
|
|
func GetMilestone(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/milestones/{id} issue issueGetMilestone
|
|
// ---
|
|
// summary: Get a milestone
|
|
// 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: the milestone to get, identified by ID and if not available by name
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/Milestone"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
milestone := getMilestoneByIDOrName(ctx)
|
|
if ctx.Written() {
|
|
return
|
|
}
|
|
|
|
ctx.JSON(http.StatusOK, convert.ToAPIMilestone(milestone))
|
|
}
|
|
|
|
// CreateMilestone create a milestone for a repository
|
|
func CreateMilestone(ctx *context.APIContext) {
|
|
// swagger:operation POST /repos/{owner}/{repo}/milestones issue issueCreateMilestone
|
|
// ---
|
|
// summary: Create a milestone
|
|
// 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/CreateMilestoneOption"
|
|
// responses:
|
|
// "201":
|
|
// "$ref": "#/responses/Milestone"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
form := web.GetForm(ctx).(*api.CreateMilestoneOption)
|
|
|
|
if form.Deadline == nil {
|
|
defaultDeadline, _ := time.ParseInLocation("2006-01-02", "9999-12-31", time.Local)
|
|
form.Deadline = &defaultDeadline
|
|
}
|
|
|
|
milestone := &issues_model.Milestone{
|
|
RepoID: ctx.Repo.Repository.ID,
|
|
Name: form.Title,
|
|
Content: form.Description,
|
|
DeadlineUnix: timeutil.TimeStamp(form.Deadline.Unix()),
|
|
}
|
|
|
|
if form.State == "closed" {
|
|
milestone.IsClosed = true
|
|
milestone.ClosedDateUnix = timeutil.TimeStampNow()
|
|
}
|
|
|
|
if err := issues_model.NewMilestone(milestone); err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "NewMilestone", err)
|
|
return
|
|
}
|
|
ctx.JSON(http.StatusCreated, convert.ToAPIMilestone(milestone))
|
|
}
|
|
|
|
// EditMilestone modify a milestone for a repository by ID and if not available by name
|
|
func EditMilestone(ctx *context.APIContext) {
|
|
// swagger:operation PATCH /repos/{owner}/{repo}/milestones/{id} issue issueEditMilestone
|
|
// ---
|
|
// summary: Update a milestone
|
|
// 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: the milestone to edit, identified by ID and if not available by name
|
|
// type: string
|
|
// required: true
|
|
// - name: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/EditMilestoneOption"
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/Milestone"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
form := web.GetForm(ctx).(*api.EditMilestoneOption)
|
|
milestone := getMilestoneByIDOrName(ctx)
|
|
if ctx.Written() {
|
|
return
|
|
}
|
|
|
|
if len(form.Title) > 0 {
|
|
milestone.Name = form.Title
|
|
}
|
|
if form.Description != nil {
|
|
milestone.Content = *form.Description
|
|
}
|
|
if form.Deadline != nil && !form.Deadline.IsZero() {
|
|
milestone.DeadlineUnix = timeutil.TimeStamp(form.Deadline.Unix())
|
|
}
|
|
|
|
oldIsClosed := milestone.IsClosed
|
|
if form.State != nil {
|
|
milestone.IsClosed = *form.State == string(api.StateClosed)
|
|
}
|
|
|
|
if err := issues_model.UpdateMilestone(milestone, oldIsClosed); err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "UpdateMilestone", err)
|
|
return
|
|
}
|
|
ctx.JSON(http.StatusOK, convert.ToAPIMilestone(milestone))
|
|
}
|
|
|
|
// DeleteMilestone delete a milestone for a repository by ID and if not available by name
|
|
func DeleteMilestone(ctx *context.APIContext) {
|
|
// swagger:operation DELETE /repos/{owner}/{repo}/milestones/{id} issue issueDeleteMilestone
|
|
// ---
|
|
// summary: Delete a milestone
|
|
// 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: the milestone to delete, identified by ID and if not available by name
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
m := getMilestoneByIDOrName(ctx)
|
|
if ctx.Written() {
|
|
return
|
|
}
|
|
|
|
if err := issues_model.DeleteMilestoneByRepoID(ctx.Repo.Repository.ID, m.ID); err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "DeleteMilestoneByRepoID", err)
|
|
return
|
|
}
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|
|
|
|
// getMilestoneByIDOrName get milestone by ID and if not available by name
|
|
func getMilestoneByIDOrName(ctx *context.APIContext) *issues_model.Milestone {
|
|
mile := ctx.Params(":id")
|
|
mileID, _ := strconv.ParseInt(mile, 0, 64)
|
|
|
|
if mileID != 0 {
|
|
milestone, err := issues_model.GetMilestoneByRepoID(ctx, ctx.Repo.Repository.ID, mileID)
|
|
if err == nil {
|
|
return milestone
|
|
} else if !issues_model.IsErrMilestoneNotExist(err) {
|
|
ctx.Error(http.StatusInternalServerError, "GetMilestoneByRepoID", err)
|
|
return nil
|
|
}
|
|
}
|
|
|
|
milestone, err := issues_model.GetMilestoneByRepoIDANDName(ctx.Repo.Repository.ID, mile)
|
|
if err != nil {
|
|
if issues_model.IsErrMilestoneNotExist(err) {
|
|
ctx.NotFound()
|
|
return nil
|
|
}
|
|
ctx.Error(http.StatusInternalServerError, "GetMilestoneByRepoID", err)
|
|
return nil
|
|
}
|
|
|
|
return milestone
|
|
}
|