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.

Sign up for GitHub

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

Jump to bottom

[API] Milestone endpoints accept names too #12649

Merged
merged 14 commits into from
Sep 14, 2020
Merged

[API] Milestone endpoints accept names too #12649

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
4c20383
API: Milestone endpoints accept names too
6543 Aug 30, 2020
27c93f2
add test
6543 Aug 30, 2020
146fe6d
Merge branch 'master' into api-milestones-accept-names
6543 Aug 30, 2020
79215db
Merge branch 'master' into api-milestones-accept-names
6543 Aug 31, 2020
f8baa77
Merge branch 'master' into api-milestones-accept-names
6543 Sep 1, 2020
0cdc46d
rename
6543 Sep 2, 2020
6b53e50
Merge branch 'master' into api-milestones-accept-names
6543 Sep 2, 2020
03628cc
Merge branch 'master' into api-milestones-accept-names
6543 Sep 4, 2020
3ac6969
Merge branch 'master' into api-milestones-accept-names
6543 Sep 4, 2020
46c1f7b
Merge branch 'master' into api-milestones-accept-names
6543 Sep 5, 2020
b9f571b
Merge branch 'master' into api-milestones-accept-names
6543 Sep 10, 2020
afe9e3c
Merge branch 'master' into api-milestones-accept-names
6543 Sep 11, 2020
8e1f721
Merge branch 'master' into api-milestones-accept-names
6543 Sep 14, 2020
51ebde6
Merge branch 'master' into api-milestones-accept-names
lafriks Sep 14, 2020
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
5 changes: 5 additions & 0 deletions integrations/api_issue_milestone_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ func TestAPIIssuesMilestone(t *testing.T) {
DecodeJSON(t, resp, &apiMilestones)
assert.Len(t, apiMilestones, 4)

req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/milestones/%s?token=%s", owner.Name, repo.Name, apiMilestones[2].Title, token))
resp = session.MakeRequest(t, req, http.StatusOK)
DecodeJSON(t, resp, &apiMilestone)
assert.EqualValues(t, apiMilestones[2], apiMilestone)

req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/milestones?state=%s&name=%s&token=%s", owner.Name, repo.Name, "all", "milestone2", token))
resp = session.MakeRequest(t, req, http.StatusOK)
DecodeJSON(t, resp, &apiMilestones)
Expand Down
76 changes: 49 additions & 27 deletions routers/api/v1/repo/milestone.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ package repo

import (
"net/http"
"strconv"
"time"

"code.gitea.io/gitea/models"
Expand Down Expand Up @@ -73,7 +74,7 @@ func ListMilestones(ctx *context.APIContext) {
ctx.JSON(http.StatusOK, &apiMilestones)
}

// GetMilestone get a milestone for a repository
// 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
// ---
Expand All @@ -93,23 +94,18 @@ func GetMilestone(ctx *context.APIContext) {
// required: true
// - name: id
// in: path
// description: id of the milestone
// type: integer
// format: int64
// description: the milestone to get, identified by ID and if not available by name
// type: string
// required: true
// responses:
// "200":
// "$ref": "#/responses/Milestone"

milestone, err := models.GetMilestoneByRepoID(ctx.Repo.Repository.ID, ctx.ParamsInt64(":id"))
if err != nil {
if models.IsErrMilestoneNotExist(err) {
ctx.NotFound()
} else {
ctx.Error(http.StatusInternalServerError, "GetMilestoneByRepoID", err)
}
milestone := getMilestoneByIDOrName(ctx)
if ctx.Written() {
return
}

ctx.JSON(http.StatusOK, convert.ToAPIMilestone(milestone))
}

Expand Down Expand Up @@ -165,7 +161,7 @@ func CreateMilestone(ctx *context.APIContext, form api.CreateMilestoneOption) {
ctx.JSON(http.StatusCreated, convert.ToAPIMilestone(milestone))
}

// EditMilestone modify a milestone for a repository
// EditMilestone modify a milestone for a repository by ID and if not available by name
func EditMilestone(ctx *context.APIContext, form api.EditMilestoneOption) {
// swagger:operation PATCH /repos/{owner}/{repo}/milestones/{id} issue issueEditMilestone
// ---
Expand All @@ -187,9 +183,8 @@ func EditMilestone(ctx *context.APIContext, form api.EditMilestoneOption) {
// required: true
// - name: id
// in: path
// description: id of the milestone
// type: integer
// format: int64
// description: the milestone to edit, identified by ID and if not available by name
// type: string
// required: true
// - name: body
// in: body
Expand All @@ -199,13 +194,8 @@ func EditMilestone(ctx *context.APIContext, form api.EditMilestoneOption) {
// "200":
// "$ref": "#/responses/Milestone"

milestone, err := models.GetMilestoneByRepoID(ctx.Repo.Repository.ID, ctx.ParamsInt64(":id"))
if err != nil {
if models.IsErrMilestoneNotExist(err) {
ctx.NotFound()
} else {
ctx.Error(http.StatusInternalServerError, "GetMilestoneByRepoID", err)
}
milestone := getMilestoneByIDOrName(ctx)
if ctx.Written() {
return
}

Expand All @@ -231,7 +221,7 @@ func EditMilestone(ctx *context.APIContext, form api.EditMilestoneOption) {
ctx.JSON(http.StatusOK, convert.ToAPIMilestone(milestone))
}

// DeleteMilestone delete a milestone for a repository
// 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
// ---
Expand All @@ -249,17 +239,49 @@ func DeleteMilestone(ctx *context.APIContext) {
// required: true
// - name: id
// in: path
// description: id of the milestone to delete
// type: integer
// format: int64
// description: the milestone to delete, identified by ID and if not available by name
// type: string
// required: true
// responses:
// "204":
// "$ref": "#/responses/empty"

if err := models.DeleteMilestoneByRepoID(ctx.Repo.Repository.ID, ctx.ParamsInt64(":id")); err != nil {
m := getMilestoneByIDOrName(ctx)
if ctx.Written() {
return
}

if err := models.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) *models.Milestone {
mile := ctx.Params(":id")
mileID, _ := strconv.ParseInt(mile, 0, 64)

if mileID != 0 {
milestone, err := models.GetMilestoneByRepoID(ctx.Repo.Repository.ID, mileID)
if err == nil {
return milestone
} else if !models.IsErrMilestoneNotExist(err) {
ctx.Error(http.StatusInternalServerError, "GetMilestoneByRepoID", err)
return nil
}
}

milestone, err := models.GetMilestoneByRepoIDANDName(ctx.Repo.Repository.ID, mile)
if err != nil {
if models.IsErrMilestoneNotExist(err) {
ctx.NotFound()
return nil
}
ctx.Error(http.StatusInternalServerError, "GetMilestoneByRepoID", err)
return nil
}

return milestone
}
15 changes: 6 additions & 9 deletions templates/swagger/v1_json.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6353,9 +6353,8 @@
"required": true
},
{
"type": "integer",
"format": "int64",
"description": "id of the milestone",
"type": "string",
"description": "the milestone to get, identified by ID and if not available by name",
"name": "id",
"in": "path",
"required": true
Expand Down Expand Up @@ -6389,9 +6388,8 @@
"required": true
},
{
"type": "integer",
"format": "int64",
"description": "id of the milestone to delete",
"type": "string",
"description": "the milestone to delete, identified by ID and if not available by name",
"name": "id",
"in": "path",
"required": true
Expand Down Expand Up @@ -6431,9 +6429,8 @@
"required": true
},
{
"type": "integer",
"format": "int64",
"description": "id of the milestone",
"type": "string",
"description": "the milestone to edit, identified by ID and if not available by name",
"name": "id",
"in": "path",
"required": true
Expand Down