From 2848c5eb8f7333b6791afd296b12d21751d0516b Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Fri, 20 Dec 2019 18:07:12 +0100 Subject: [PATCH] Swagger info corrections (#9441) * 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 :+1: * use ctx.InternalServerError * Revert "use numbers and not http.Status___ enum" This reverts commit b1ff386e2418ed6a7f183e756b13277d701278ef. * use http.Status* enum everywhere --- modules/context/api.go | 7 + routers/api/v1/admin/org.go | 14 +- routers/api/v1/admin/repo.go | 5 + routers/api/v1/admin/user.go | 47 ++-- routers/api/v1/api.go | 57 ++--- routers/api/v1/misc/markdown.go | 14 +- routers/api/v1/misc/swagger.go | 4 +- routers/api/v1/misc/version.go | 4 +- routers/api/v1/org/hook.go | 15 +- routers/api/v1/org/member.go | 44 ++-- routers/api/v1/org/org.go | 29 ++- routers/api/v1/org/team.go | 103 +++++---- routers/api/v1/repo/blob.go | 2 + routers/api/v1/repo/branch.go | 20 +- routers/api/v1/repo/collaborators.go | 45 ++-- routers/api/v1/repo/commits.go | 7 +- routers/api/v1/repo/file.go | 10 + routers/api/v1/repo/fork.go | 26 ++- routers/api/v1/repo/git_hook.go | 26 ++- routers/api/v1/repo/git_ref.go | 8 +- routers/api/v1/repo/hook.go | 23 +- routers/api/v1/repo/issue.go | 88 +++++--- routers/api/v1/repo/issue_comment.go | 65 +++--- routers/api/v1/repo/issue_label.go | 67 +++--- routers/api/v1/repo/issue_reaction.go | 75 ++++--- routers/api/v1/repo/issue_stopwatch.go | 39 ++-- routers/api/v1/repo/issue_subscription.go | 29 +-- routers/api/v1/repo/issue_tracked_time.go | 49 +++-- routers/api/v1/repo/key.go | 43 ++-- routers/api/v1/repo/label.go | 26 ++- routers/api/v1/repo/milestone.go | 26 ++- routers/api/v1/repo/pull.go | 112 ++++++---- routers/api/v1/repo/release.go | 45 ++-- routers/api/v1/repo/release_attachment.go | 37 ++-- routers/api/v1/repo/repo.go | 101 +++++---- routers/api/v1/repo/star.go | 7 +- routers/api/v1/repo/status.go | 36 ++-- routers/api/v1/repo/subscriber.go | 7 +- routers/api/v1/repo/tag.go | 7 +- routers/api/v1/repo/topic.go | 48 +++-- routers/api/v1/repo/tree.go | 10 +- routers/api/v1/user/app.go | 17 +- routers/api/v1/user/email.go | 25 ++- routers/api/v1/user/follower.go | 26 ++- routers/api/v1/user/gpg_key.go | 29 ++- routers/api/v1/user/key.go | 25 ++- routers/api/v1/user/repo.go | 17 +- routers/api/v1/user/star.go | 25 ++- routers/api/v1/user/user.go | 15 +- routers/api/v1/user/watch.go | 25 ++- routers/api/v1/utils/hook.go | 32 +-- templates/swagger/v1_json.tmpl | 247 +++++++++++++++++++++- 52 files changed, 1262 insertions(+), 648 deletions(-) diff --git a/modules/context/api.go b/modules/context/api.go index c1de37dd21a09..fd9983c52b5b4 100644 --- a/modules/context/api.go +++ b/modules/context/api.go @@ -39,6 +39,13 @@ type APIValidationError struct { URL string `json:"url"` } +// APIInvalidTopicsError is error format response to invalid topics +// swagger:response invalidTopicsError +type APIInvalidTopicsError struct { + Topics []string `json:"invalidTopics"` + Message string `json:"message"` +} + //APIEmpty is an empty response // swagger:response empty type APIEmpty struct{} diff --git a/routers/api/v1/admin/org.go b/routers/api/v1/admin/org.go index 8d3b0123c532c..1db4e592ff496 100644 --- a/routers/api/v1/admin/org.go +++ b/routers/api/v1/admin/org.go @@ -6,6 +6,8 @@ package admin import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" @@ -39,6 +41,7 @@ func CreateOrg(ctx *context.APIContext, form api.CreateOrgOption) { // "$ref": "#/responses/forbidden" // "422": // "$ref": "#/responses/validationError" + u := user.GetUserByParams(ctx) if ctx.Written() { return @@ -64,14 +67,14 @@ func CreateOrg(ctx *context.APIContext, form api.CreateOrgOption) { if models.IsErrUserAlreadyExist(err) || models.IsErrNameReserved(err) || models.IsErrNamePatternNotAllowed(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "CreateOrganization", err) + ctx.Error(http.StatusInternalServerError, "CreateOrganization", err) } return } - ctx.JSON(201, convert.ToOrganization(org)) + ctx.JSON(http.StatusCreated, convert.ToOrganization(org)) } //GetAllOrgs API for getting information of all the organizations @@ -95,6 +98,7 @@ func GetAllOrgs(ctx *context.APIContext) { // "$ref": "#/responses/OrganizationList" // "403": // "$ref": "#/responses/forbidden" + users, _, err := models.SearchUsers(&models.SearchUserOptions{ Type: models.UserTypeOrganization, OrderBy: models.SearchOrderByAlphabetically, @@ -103,12 +107,12 @@ func GetAllOrgs(ctx *context.APIContext) { Private: true, }) if err != nil { - ctx.Error(500, "SearchOrganizations", err) + ctx.Error(http.StatusInternalServerError, "SearchOrganizations", err) return } orgs := make([]*api.Organization, len(users)) for i := range users { orgs[i] = convert.ToOrganization(users[i]) } - ctx.JSON(200, &orgs) + ctx.JSON(http.StatusOK, &orgs) } diff --git a/routers/api/v1/admin/repo.go b/routers/api/v1/admin/repo.go index 1f64b42238077..c3ca525510aa8 100644 --- a/routers/api/v1/admin/repo.go +++ b/routers/api/v1/admin/repo.go @@ -35,8 +35,13 @@ func CreateRepo(ctx *context.APIContext, form api.CreateRepoOption) { // "$ref": "#/responses/Repository" // "403": // "$ref": "#/responses/forbidden" + // "404": + // "$ref": "#/responses/notFound" + // "409": + // "$ref": "#/responses/error" // "422": // "$ref": "#/responses/validationError" + owner := user.GetUserByParams(ctx) if ctx.Written() { return diff --git a/routers/api/v1/admin/user.go b/routers/api/v1/admin/user.go index 3a4750c6ba5a9..7387037d333c3 100644 --- a/routers/api/v1/admin/user.go +++ b/routers/api/v1/admin/user.go @@ -7,6 +7,7 @@ package admin import ( "errors" + "net/http" "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" @@ -26,9 +27,9 @@ func parseLoginSource(ctx *context.APIContext, u *models.User, sourceID int64, l source, err := models.GetLoginSourceByID(sourceID) if err != nil { if models.IsErrLoginSourceNotExist(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "GetLoginSourceByID", err) + ctx.Error(http.StatusInternalServerError, "GetLoginSourceByID", err) } return } @@ -57,8 +58,11 @@ func CreateUser(ctx *context.APIContext, form api.CreateUserOption) { // "$ref": "#/responses/User" // "403": // "$ref": "#/responses/forbidden" + // "400": + // "$ref": "#/responses/error" // "422": // "$ref": "#/responses/validationError" + u := &models.User{ Name: form.Username, FullName: form.FullName, @@ -78,7 +82,7 @@ func CreateUser(ctx *context.APIContext, form api.CreateUserOption) { } if !password.IsComplexEnough(form.Password) { err := errors.New("PasswordComplexity") - ctx.Error(400, "PasswordComplexity", err) + ctx.Error(http.StatusBadRequest, "PasswordComplexity", err) return } if err := models.CreateUser(u); err != nil { @@ -86,9 +90,9 @@ func CreateUser(ctx *context.APIContext, form api.CreateUserOption) { models.IsErrEmailAlreadyUsed(err) || models.IsErrNameReserved(err) || models.IsErrNamePatternNotAllowed(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "CreateUser", err) + ctx.Error(http.StatusInternalServerError, "CreateUser", err) } return } @@ -98,7 +102,7 @@ func CreateUser(ctx *context.APIContext, form api.CreateUserOption) { if form.SendNotify { mailer.SendRegisterNotifyMail(ctx.Locale, u) } - ctx.JSON(201, convert.ToUser(u, ctx.IsSigned, ctx.User.IsAdmin)) + ctx.JSON(http.StatusCreated, convert.ToUser(u, ctx.IsSigned, ctx.User.IsAdmin)) } // EditUser api for modifying a user's information @@ -127,6 +131,7 @@ func EditUser(ctx *context.APIContext, form api.EditUserOption) { // "$ref": "#/responses/forbidden" // "422": // "$ref": "#/responses/validationError" + u := user.GetUserByParams(ctx) if ctx.Written() { return @@ -140,12 +145,12 @@ func EditUser(ctx *context.APIContext, form api.EditUserOption) { if len(form.Password) > 0 { if !password.IsComplexEnough(form.Password) { err := errors.New("PasswordComplexity") - ctx.Error(400, "PasswordComplexity", err) + ctx.Error(http.StatusBadRequest, "PasswordComplexity", err) return } var err error if u.Salt, err = models.GetUserSalt(); err != nil { - ctx.Error(500, "UpdateUser", err) + ctx.Error(http.StatusInternalServerError, "UpdateUser", err) return } u.HashPassword(form.Password) @@ -184,15 +189,15 @@ func EditUser(ctx *context.APIContext, form api.EditUserOption) { if err := models.UpdateUser(u); err != nil { if models.IsErrEmailAlreadyUsed(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "UpdateUser", err) + ctx.Error(http.StatusInternalServerError, "UpdateUser", err) } return } log.Trace("Account profile updated by admin (%s): %s", ctx.User.Name, u.Name) - ctx.JSON(200, convert.ToUser(u, ctx.IsSigned, ctx.User.IsAdmin)) + ctx.JSON(http.StatusOK, convert.ToUser(u, ctx.IsSigned, ctx.User.IsAdmin)) } // DeleteUser api for deleting a user @@ -215,6 +220,7 @@ func DeleteUser(ctx *context.APIContext) { // "$ref": "#/responses/forbidden" // "422": // "$ref": "#/responses/validationError" + u := user.GetUserByParams(ctx) if ctx.Written() { return @@ -223,15 +229,15 @@ func DeleteUser(ctx *context.APIContext) { if err := models.DeleteUser(u); err != nil { if models.IsErrUserOwnRepos(err) || models.IsErrUserHasOrgs(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "DeleteUser", err) + ctx.Error(http.StatusInternalServerError, "DeleteUser", err) } return } log.Trace("Account deleted by admin(%s): %s", ctx.User.Name, u.Name) - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // CreatePublicKey api for creating a public key to a user @@ -260,6 +266,7 @@ func CreatePublicKey(ctx *context.APIContext, form api.CreateKeyOption) { // "$ref": "#/responses/forbidden" // "422": // "$ref": "#/responses/validationError" + u := user.GetUserByParams(ctx) if ctx.Written() { return @@ -293,6 +300,7 @@ func DeleteUserPublicKey(ctx *context.APIContext) { // "$ref": "#/responses/forbidden" // "404": // "$ref": "#/responses/notFound" + u := user.GetUserByParams(ctx) if ctx.Written() { return @@ -302,15 +310,15 @@ func DeleteUserPublicKey(ctx *context.APIContext) { if models.IsErrKeyNotExist(err) { ctx.NotFound() } else if models.IsErrKeyAccessDenied(err) { - ctx.Error(403, "", "You do not have access to this key") + ctx.Error(http.StatusForbidden, "", "You do not have access to this key") } else { - ctx.Error(500, "DeleteUserPublicKey", err) + ctx.Error(http.StatusInternalServerError, "DeleteUserPublicKey", err) } return } log.Trace("Key deleted by admin(%s): %s", ctx.User.Name, u.Name) - ctx.Status(204) + ctx.Status(http.StatusNoContent) } //GetAllUsers API for getting information of all the users @@ -325,13 +333,14 @@ func GetAllUsers(ctx *context.APIContext) { // "$ref": "#/responses/UserList" // "403": // "$ref": "#/responses/forbidden" + users, _, err := models.SearchUsers(&models.SearchUserOptions{ Type: models.UserTypeIndividual, OrderBy: models.SearchOrderByAlphabetically, PageSize: -1, }) if err != nil { - ctx.Error(500, "GetAllUsers", err) + ctx.Error(http.StatusInternalServerError, "GetAllUsers", err) return } @@ -340,5 +349,5 @@ func GetAllUsers(ctx *context.APIContext) { results[i] = convert.ToUser(users[i], ctx.IsSigned, ctx.User.IsAdmin) } - ctx.JSON(200, &results) + ctx.JSON(http.StatusOK, &results) } diff --git a/routers/api/v1/api.go b/routers/api/v1/api.go index 7526d3f5efe67..c2f019eb41e52 100644 --- a/routers/api/v1/api.go +++ b/routers/api/v1/api.go @@ -59,6 +59,7 @@ package v1 import ( + "net/http" "strings" "code.gitea.io/gitea/models" @@ -92,14 +93,14 @@ func sudo() macaron.Handler { if models.IsErrUserNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetUserByName", err) + ctx.Error(http.StatusInternalServerError, "GetUserByName", err) } return } log.Trace("Sudo from (%s) to: %s", ctx.User.Name, user.Name) ctx.User = user } else { - ctx.JSON(403, map[string]string{ + ctx.JSON(http.StatusForbidden, map[string]string{ "message": "Only administrators allowed to sudo.", }) return @@ -127,7 +128,7 @@ func repoAssignment() macaron.Handler { if models.IsErrUserNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetUserByName", err) + ctx.Error(http.StatusInternalServerError, "GetUserByName", err) } return } @@ -144,10 +145,10 @@ func repoAssignment() macaron.Handler { } else if models.IsErrRepoRedirectNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "LookupRepoRedirect", err) + ctx.Error(http.StatusInternalServerError, "LookupRepoRedirect", err) } } else { - ctx.Error(500, "GetRepositoryByName", err) + ctx.Error(http.StatusInternalServerError, "GetRepositoryByName", err) } return } @@ -157,7 +158,7 @@ func repoAssignment() macaron.Handler { ctx.Repo.Permission, err = models.GetUserRepoPermission(repo, ctx.User) if err != nil { - ctx.Error(500, "GetUserRepoPermission", err) + ctx.Error(http.StatusInternalServerError, "GetUserRepoPermission", err) return } @@ -182,14 +183,14 @@ func reqToken() macaron.Handler { ctx.RequireCSRF() return } - ctx.Context.Error(401) + ctx.Context.Error(http.StatusUnauthorized) } } func reqBasicAuth() macaron.Handler { return func(ctx *context.APIContext) { if !ctx.Context.IsBasicAuth { - ctx.Context.Error(401) + ctx.Context.Error(http.StatusUnauthorized) return } ctx.CheckForOTP() @@ -200,7 +201,7 @@ func reqBasicAuth() macaron.Handler { func reqSiteAdmin() macaron.Handler { return func(ctx *context.Context) { if !ctx.IsUserSiteAdmin() { - ctx.Error(403) + ctx.Error(http.StatusForbidden) return } } @@ -210,7 +211,7 @@ func reqSiteAdmin() macaron.Handler { func reqOwner() macaron.Handler { return func(ctx *context.Context) { if !ctx.IsUserRepoOwner() && !ctx.IsUserSiteAdmin() { - ctx.Error(403) + ctx.Error(http.StatusForbidden) return } } @@ -220,7 +221,7 @@ func reqOwner() macaron.Handler { func reqAdmin() macaron.Handler { return func(ctx *context.Context) { if !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() { - ctx.Error(403) + ctx.Error(http.StatusForbidden) return } } @@ -230,7 +231,7 @@ func reqAdmin() macaron.Handler { func reqRepoWriter(unitTypes ...models.UnitType) macaron.Handler { return func(ctx *context.Context) { if !ctx.IsUserRepoWriter(unitTypes) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() { - ctx.Error(403) + ctx.Error(http.StatusForbidden) return } } @@ -240,7 +241,7 @@ func reqRepoWriter(unitTypes ...models.UnitType) macaron.Handler { func reqRepoReader(unitType models.UnitType) macaron.Handler { return func(ctx *context.Context) { if !ctx.IsUserRepoReaderSpecific(unitType) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() { - ctx.Error(403) + ctx.Error(http.StatusForbidden) return } } @@ -250,7 +251,7 @@ func reqRepoReader(unitType models.UnitType) macaron.Handler { func reqAnyRepoReader() macaron.Handler { return func(ctx *context.Context) { if !ctx.IsUserRepoReaderAny() && !ctx.IsUserSiteAdmin() { - ctx.Error(403) + ctx.Error(http.StatusForbidden) return } } @@ -269,17 +270,17 @@ func reqOrgOwnership() macaron.Handler { } else if ctx.Org.Team != nil { orgID = ctx.Org.Team.OrgID } else { - ctx.Error(500, "", "reqOrgOwnership: unprepared context") + ctx.Error(http.StatusInternalServerError, "", "reqOrgOwnership: unprepared context") return } isOwner, err := models.IsOrganizationOwner(orgID, ctx.User.ID) if err != nil { - ctx.Error(500, "IsOrganizationOwner", err) + ctx.Error(http.StatusInternalServerError, "IsOrganizationOwner", err) return } else if !isOwner { if ctx.Org.Organization != nil { - ctx.Error(403, "", "Must be an organization owner") + ctx.Error(http.StatusForbidden, "", "Must be an organization owner") } else { ctx.NotFound() } @@ -295,28 +296,28 @@ func reqTeamMembership() macaron.Handler { return } if ctx.Org.Team == nil { - ctx.Error(500, "", "reqTeamMembership: unprepared context") + ctx.Error(http.StatusInternalServerError, "", "reqTeamMembership: unprepared context") return } var orgID = ctx.Org.Team.OrgID isOwner, err := models.IsOrganizationOwner(orgID, ctx.User.ID) if err != nil { - ctx.Error(500, "IsOrganizationOwner", err) + ctx.Error(http.StatusInternalServerError, "IsOrganizationOwner", err) return } else if isOwner { return } if isTeamMember, err := models.IsTeamMember(orgID, ctx.Org.Team.ID, ctx.User.ID); err != nil { - ctx.Error(500, "IsTeamMember", err) + ctx.Error(http.StatusInternalServerError, "IsTeamMember", err) return } else if !isTeamMember { isOrgMember, err := models.IsOrganizationMember(orgID, ctx.User.ID) if err != nil { - ctx.Error(500, "IsOrganizationMember", err) + ctx.Error(http.StatusInternalServerError, "IsOrganizationMember", err) } else if isOrgMember { - ctx.Error(403, "", "Must be a team member") + ctx.Error(http.StatusForbidden, "", "Must be a team member") } else { ctx.NotFound() } @@ -338,16 +339,16 @@ func reqOrgMembership() macaron.Handler { } else if ctx.Org.Team != nil { orgID = ctx.Org.Team.OrgID } else { - ctx.Error(500, "", "reqOrgMembership: unprepared context") + ctx.Error(http.StatusInternalServerError, "", "reqOrgMembership: unprepared context") return } if isMember, err := models.IsOrganizationMember(orgID, ctx.User.ID); err != nil { - ctx.Error(500, "IsOrganizationMember", err) + ctx.Error(http.StatusInternalServerError, "IsOrganizationMember", err) return } else if !isMember { if ctx.Org.Organization != nil { - ctx.Error(403, "", "Must be an organization member") + ctx.Error(http.StatusForbidden, "", "Must be an organization member") } else { ctx.NotFound() } @@ -359,7 +360,7 @@ func reqOrgMembership() macaron.Handler { func reqGitHook() macaron.Handler { return func(ctx *context.APIContext) { if !ctx.User.CanEditGitHook() { - ctx.Error(403, "", "must be allowed to edit Git hooks") + ctx.Error(http.StatusForbidden, "", "must be allowed to edit Git hooks") return } } @@ -386,7 +387,7 @@ func orgAssignment(args ...bool) macaron.Handler { if models.IsErrOrgNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetOrgByName", err) + ctx.Error(http.StatusInternalServerError, "GetOrgByName", err) } return } @@ -398,7 +399,7 @@ func orgAssignment(args ...bool) macaron.Handler { if models.IsErrUserNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetTeamById", err) + ctx.Error(http.StatusInternalServerError, "GetTeamById", err) } return } diff --git a/routers/api/v1/misc/markdown.go b/routers/api/v1/misc/markdown.go index 23f0b168d0849..5a44db5e8bccd 100644 --- a/routers/api/v1/misc/markdown.go +++ b/routers/api/v1/misc/markdown.go @@ -36,8 +36,9 @@ func Markdown(ctx *context.APIContext, form api.MarkdownOption) { // "$ref": "#/responses/MarkdownRender" // "422": // "$ref": "#/responses/validationError" + if ctx.HasAPIError() { - ctx.Error(422, "", ctx.GetErrMsg()) + ctx.Error(http.StatusUnprocessableEntity, "", ctx.GetErrMsg()) return } @@ -65,20 +66,20 @@ func Markdown(ctx *context.APIContext, form api.MarkdownOption) { if form.Wiki { _, err := ctx.Write([]byte(markdown.RenderWiki(md, urlPrefix, meta))) if err != nil { - ctx.Error(http.StatusInternalServerError, "", err) + ctx.InternalServerError(err) return } } else { _, err := ctx.Write(markdown.Render(md, urlPrefix, meta)) if err != nil { - ctx.Error(http.StatusInternalServerError, "", err) + ctx.InternalServerError(err) return } } default: _, err := ctx.Write(markdown.RenderRaw([]byte(form.Text), "", false)) if err != nil { - ctx.Error(http.StatusInternalServerError, "", err) + ctx.InternalServerError(err) return } } @@ -105,14 +106,15 @@ func MarkdownRaw(ctx *context.APIContext) { // "$ref": "#/responses/MarkdownRender" // "422": // "$ref": "#/responses/validationError" + body, err := ctx.Req.Body().Bytes() if err != nil { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) return } _, err = ctx.Write(markdown.RenderRaw(body, "", false)) if err != nil { - ctx.Error(http.StatusInternalServerError, "", err) + ctx.InternalServerError(err) return } } diff --git a/routers/api/v1/misc/swagger.go b/routers/api/v1/misc/swagger.go index e17b77522769c..e46d4194b46e8 100644 --- a/routers/api/v1/misc/swagger.go +++ b/routers/api/v1/misc/swagger.go @@ -5,6 +5,8 @@ package misc import ( + "net/http" + "code.gitea.io/gitea/modules/base" "code.gitea.io/gitea/modules/context" ) @@ -15,5 +17,5 @@ const tplSwagger base.TplName = "swagger/ui" // Swagger render swagger-ui page with v1 json func Swagger(ctx *context.Context) { ctx.Data["APIJSONVersion"] = "v1" - ctx.HTML(200, tplSwagger) + ctx.HTML(http.StatusOK, tplSwagger) } diff --git a/routers/api/v1/misc/version.go b/routers/api/v1/misc/version.go index 803f5ac716f55..b8c7d4f9ada26 100644 --- a/routers/api/v1/misc/version.go +++ b/routers/api/v1/misc/version.go @@ -5,6 +5,8 @@ package misc import ( + "net/http" + "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/structs" @@ -20,5 +22,5 @@ func Version(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/ServerVersion" - ctx.JSON(200, &structs.ServerVersion{Version: setting.AppVer}) + ctx.JSON(http.StatusOK, &structs.ServerVersion{Version: setting.AppVer}) } diff --git a/routers/api/v1/org/hook.go b/routers/api/v1/org/hook.go index c7b0bd5b6b154..b3faac7b516f5 100644 --- a/routers/api/v1/org/hook.go +++ b/routers/api/v1/org/hook.go @@ -5,6 +5,8 @@ package org import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" @@ -28,17 +30,18 @@ func ListHooks(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/HookList" + org := ctx.Org.Organization orgHooks, err := models.GetWebhooksByOrgID(org.ID) if err != nil { - ctx.Error(500, "GetWebhooksByOrgID", err) + ctx.Error(http.StatusInternalServerError, "GetWebhooksByOrgID", err) return } hooks := make([]*api.Hook, len(orgHooks)) for i, hook := range orgHooks { hooks[i] = convert.ToHook(org.HomeLink(), hook) } - ctx.JSON(200, hooks) + ctx.JSON(http.StatusOK, hooks) } // GetHook get an organization's hook by id @@ -63,13 +66,14 @@ func GetHook(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Hook" + org := ctx.Org.Organization hookID := ctx.ParamsInt64(":id") hook, err := utils.GetOrgHook(ctx, org.ID, hookID) if err != nil { return } - ctx.JSON(200, convert.ToHook(org.HomeLink(), hook)) + ctx.JSON(http.StatusOK, convert.ToHook(org.HomeLink(), hook)) } // CreateHook create a hook for an organization @@ -159,15 +163,16 @@ func DeleteHook(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + org := ctx.Org.Organization hookID := ctx.ParamsInt64(":id") if err := models.DeleteWebhookByOrgID(org.ID, hookID); err != nil { if models.IsErrWebhookNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "DeleteWebhookByOrgID", err) + ctx.Error(http.StatusInternalServerError, "DeleteWebhookByOrgID", err) } return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/org/member.go b/routers/api/v1/org/member.go index 45519e56062a7..1575600a652db 100644 --- a/routers/api/v1/org/member.go +++ b/routers/api/v1/org/member.go @@ -6,6 +6,7 @@ package org import ( "fmt" + "net/http" "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" @@ -23,7 +24,7 @@ func listMembers(ctx *context.APIContext, publicOnly bool) { PublicOnly: publicOnly, }) if err != nil { - ctx.Error(500, "GetUsersByIDs", err) + ctx.Error(http.StatusInternalServerError, "GetUsersByIDs", err) return } @@ -31,7 +32,7 @@ func listMembers(ctx *context.APIContext, publicOnly bool) { for i, member := range members { apiMembers[i] = convert.ToUser(member, ctx.IsSigned, ctx.User != nil && ctx.User.IsAdmin) } - ctx.JSON(200, apiMembers) + ctx.JSON(http.StatusOK, apiMembers) } // ListMembers list an organization's members @@ -50,11 +51,12 @@ func ListMembers(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + publicOnly := true if ctx.User != nil { isMember, err := ctx.Org.Organization.IsOrgMember(ctx.User.ID) if err != nil { - ctx.Error(500, "IsOrgMember", err) + ctx.Error(http.StatusInternalServerError, "IsOrgMember", err) return } publicOnly = !isMember @@ -78,6 +80,7 @@ func ListPublicMembers(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + listMembers(ctx, true) } @@ -100,8 +103,11 @@ func IsMember(ctx *context.APIContext) { // responses: // "204": // description: user is a member + // "302": + // description: redirection to /orgs/{org}/public_members/{username} // "404": // description: user is not a member + userToCheck := user.GetUserByParams(ctx) if ctx.Written() { return @@ -109,14 +115,14 @@ func IsMember(ctx *context.APIContext) { if ctx.User != nil { userIsMember, err := ctx.Org.Organization.IsOrgMember(ctx.User.ID) if err != nil { - ctx.Error(500, "IsOrgMember", err) + ctx.Error(http.StatusInternalServerError, "IsOrgMember", err) return } else if userIsMember { userToCheckIsMember, err := ctx.Org.Organization.IsOrgMember(userToCheck.ID) if err != nil { - ctx.Error(500, "IsOrgMember", err) + ctx.Error(http.StatusInternalServerError, "IsOrgMember", err) } else if userToCheckIsMember { - ctx.Status(204) + ctx.Status(http.StatusNoContent) } else { ctx.NotFound() } @@ -153,12 +159,13 @@ func IsPublicMember(ctx *context.APIContext) { // description: user is a public member // "404": // description: user is not a public member + userToCheck := user.GetUserByParams(ctx) if ctx.Written() { return } if userToCheck.IsPublicMember(ctx.Org.Organization.ID) { - ctx.Status(204) + ctx.Status(http.StatusNoContent) } else { ctx.NotFound() } @@ -185,20 +192,23 @@ func PublicizeMember(ctx *context.APIContext) { // responses: // "204": // description: membership publicized + // "403": + // "$ref": "#/responses/forbidden" + userToPublicize := user.GetUserByParams(ctx) if ctx.Written() { return } if userToPublicize.ID != ctx.User.ID { - ctx.Error(403, "", "Cannot publicize another member") + ctx.Error(http.StatusForbidden, "", "Cannot publicize another member") return } err := models.ChangeOrgUserStatus(ctx.Org.Organization.ID, userToPublicize.ID, true) if err != nil { - ctx.Error(500, "ChangeOrgUserStatus", err) + ctx.Error(http.StatusInternalServerError, "ChangeOrgUserStatus", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // ConcealMember make a member's membership not public @@ -222,20 +232,23 @@ func ConcealMember(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + userToConceal := user.GetUserByParams(ctx) if ctx.Written() { return } if userToConceal.ID != ctx.User.ID { - ctx.Error(403, "", "Cannot conceal another member") + ctx.Error(http.StatusForbidden, "", "Cannot conceal another member") return } err := models.ChangeOrgUserStatus(ctx.Org.Organization.ID, userToConceal.ID, false) if err != nil { - ctx.Error(500, "ChangeOrgUserStatus", err) + ctx.Error(http.StatusInternalServerError, "ChangeOrgUserStatus", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // DeleteMember remove a member from an organization @@ -259,12 +272,13 @@ func DeleteMember(ctx *context.APIContext) { // responses: // "204": // description: member removed + member := user.GetUserByParams(ctx) if ctx.Written() { return } if err := ctx.Org.Organization.RemoveMember(member.ID); err != nil { - ctx.Error(500, "RemoveMember", err) + ctx.Error(http.StatusInternalServerError, "RemoveMember", err) } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/org/org.go b/routers/api/v1/org/org.go index d698592361d22..67770e70aa62c 100644 --- a/routers/api/v1/org/org.go +++ b/routers/api/v1/org/org.go @@ -6,6 +6,8 @@ package org import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" @@ -15,7 +17,7 @@ import ( func listUserOrgs(ctx *context.APIContext, u *models.User, all bool) { if err := u.GetOrganizations(all); err != nil { - ctx.Error(500, "GetOrganizations", err) + ctx.Error(http.StatusInternalServerError, "GetOrganizations", err) return } @@ -23,7 +25,7 @@ func listUserOrgs(ctx *context.APIContext, u *models.User, all bool) { for i := range u.Orgs { apiOrgs[i] = convert.ToOrganization(u.Orgs[i]) } - ctx.JSON(200, &apiOrgs) + ctx.JSON(http.StatusOK, &apiOrgs) } // ListMyOrgs list all my orgs @@ -36,6 +38,7 @@ func ListMyOrgs(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/OrganizationList" + listUserOrgs(ctx, ctx.User, true) } @@ -55,6 +58,7 @@ func ListUserOrgs(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/OrganizationList" + u := user.GetUserByParams(ctx) if ctx.Written() { return @@ -85,7 +89,7 @@ func Create(ctx *context.APIContext, form api.CreateOrgOption) { // "$ref": "#/responses/validationError" if !ctx.User.CanCreateOrganization() { - ctx.Error(403, "Create organization not allowed", nil) + ctx.Error(http.StatusForbidden, "Create organization not allowed", nil) return } @@ -109,14 +113,14 @@ func Create(ctx *context.APIContext, form api.CreateOrgOption) { if models.IsErrUserAlreadyExist(err) || models.IsErrNameReserved(err) || models.IsErrNamePatternNotAllowed(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "CreateOrganization", err) + ctx.Error(http.StatusInternalServerError, "CreateOrganization", err) } return } - ctx.JSON(201, convert.ToOrganization(org)) + ctx.JSON(http.StatusCreated, convert.ToOrganization(org)) } // Get get an organization @@ -135,11 +139,12 @@ func Get(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Organization" + if !models.HasOrgVisible(ctx.Org.Organization, ctx.User) { ctx.NotFound("HasOrgVisible", nil) return } - ctx.JSON(200, convert.ToOrganization(ctx.Org.Organization)) + ctx.JSON(http.StatusOK, convert.ToOrganization(ctx.Org.Organization)) } // Edit change an organization's information @@ -165,6 +170,7 @@ func Edit(ctx *context.APIContext, form api.EditOrgOption) { // responses: // "200": // "$ref": "#/responses/Organization" + org := ctx.Org.Organization org.FullName = form.FullName org.Description = form.Description @@ -174,11 +180,11 @@ func Edit(ctx *context.APIContext, form api.EditOrgOption) { org.Visibility = api.VisibilityModes[form.Visibility] } if err := models.UpdateUserCols(org, "full_name", "description", "website", "location", "visibility"); err != nil { - ctx.Error(500, "EditOrganization", err) + ctx.Error(http.StatusInternalServerError, "EditOrganization", err) return } - ctx.JSON(200, convert.ToOrganization(org)) + ctx.JSON(http.StatusOK, convert.ToOrganization(org)) } //Delete an organization @@ -197,9 +203,10 @@ func Delete(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + if err := models.DeleteOrganization(ctx.Org.Organization); err != nil { - ctx.Error(500, "DeleteOrganization", err) + ctx.Error(http.StatusInternalServerError, "DeleteOrganization", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/org/team.go b/routers/api/v1/org/team.go index c14742e3a4e64..73714e6a66356 100644 --- a/routers/api/v1/org/team.go +++ b/routers/api/v1/org/team.go @@ -6,6 +6,7 @@ package org import ( + "net/http" "strings" "code.gitea.io/gitea/models" @@ -32,22 +33,23 @@ func ListTeams(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/TeamList" + org := ctx.Org.Organization if err := org.GetTeams(); err != nil { - ctx.Error(500, "GetTeams", err) + ctx.Error(http.StatusInternalServerError, "GetTeams", err) return } apiTeams := make([]*api.Team, len(org.Teams)) for i := range org.Teams { if err := org.Teams[i].GetUnits(); err != nil { - ctx.Error(500, "GetUnits", err) + ctx.Error(http.StatusInternalServerError, "GetUnits", err) return } apiTeams[i] = convert.ToTeam(org.Teams[i]) } - ctx.JSON(200, apiTeams) + ctx.JSON(http.StatusOK, apiTeams) } // ListUserTeams list all the teams a user belongs to @@ -60,9 +62,10 @@ func ListUserTeams(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/TeamList" + teams, err := models.GetUserTeams(ctx.User.ID) if err != nil { - ctx.Error(500, "GetUserTeams", err) + ctx.Error(http.StatusInternalServerError, "GetUserTeams", err) return } @@ -73,7 +76,7 @@ func ListUserTeams(ctx *context.APIContext) { if !ok { org, err := models.GetUserByID(teams[i].OrgID) if err != nil { - ctx.Error(500, "GetUserByID", err) + ctx.Error(http.StatusInternalServerError, "GetUserByID", err) return } apiOrg = convert.ToOrganization(org) @@ -82,7 +85,7 @@ func ListUserTeams(ctx *context.APIContext) { apiTeams[i] = convert.ToTeam(teams[i]) apiTeams[i].Organization = apiOrg } - ctx.JSON(200, apiTeams) + ctx.JSON(http.StatusOK, apiTeams) } // GetTeam api for get a team @@ -102,7 +105,8 @@ func GetTeam(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Team" - ctx.JSON(200, convert.ToTeam(ctx.Org.Team)) + + ctx.JSON(http.StatusOK, convert.ToTeam(ctx.Org.Team)) } // CreateTeam api for create a team @@ -127,6 +131,9 @@ func CreateTeam(ctx *context.APIContext, form api.CreateTeamOption) { // responses: // "201": // "$ref": "#/responses/Team" + // "422": + // "$ref": "#/responses/validationError" + team := &models.Team{ OrgID: ctx.Org.Organization.ID, Name: form.Name, @@ -151,14 +158,14 @@ func CreateTeam(ctx *context.APIContext, form api.CreateTeamOption) { if err := models.NewTeam(team); err != nil { if models.IsErrTeamAlreadyExist(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "NewTeam", err) + ctx.Error(http.StatusInternalServerError, "NewTeam", err) } return } - ctx.JSON(201, convert.ToTeam(team)) + ctx.JSON(http.StatusCreated, convert.ToTeam(team)) } // EditTeam api for edit a team @@ -183,6 +190,7 @@ func EditTeam(ctx *context.APIContext, form api.EditTeamOption) { // responses: // "200": // "$ref": "#/responses/Team" + team := ctx.Org.Team team.Description = form.Description unitTypes := models.FindUnitTypes(form.Units...) @@ -218,10 +226,10 @@ func EditTeam(ctx *context.APIContext, form api.EditTeamOption) { } if err := models.UpdateTeam(team, isAuthChanged, isIncludeAllChanged); err != nil { - ctx.Error(500, "EditTeam", err) + ctx.Error(http.StatusInternalServerError, "EditTeam", err) return } - ctx.JSON(200, convert.ToTeam(team)) + ctx.JSON(http.StatusOK, convert.ToTeam(team)) } // DeleteTeam api for delete a team @@ -239,11 +247,12 @@ func DeleteTeam(ctx *context.APIContext) { // responses: // "204": // description: team deleted + if err := models.DeleteTeam(ctx.Org.Team); err != nil { - ctx.Error(500, "DeleteTeam", err) + ctx.Error(http.StatusInternalServerError, "DeleteTeam", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // GetTeamMembers api for get a team's members @@ -263,9 +272,10 @@ func GetTeamMembers(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + isMember, err := models.IsOrganizationMember(ctx.Org.Team.OrgID, ctx.User.ID) if err != nil { - ctx.Error(500, "IsOrganizationMember", err) + ctx.Error(http.StatusInternalServerError, "IsOrganizationMember", err) return } else if !isMember { ctx.NotFound() @@ -273,14 +283,14 @@ func GetTeamMembers(ctx *context.APIContext) { } team := ctx.Org.Team if err := team.GetMembers(); err != nil { - ctx.Error(500, "GetTeamMembers", err) + ctx.Error(http.StatusInternalServerError, "GetTeamMembers", err) return } members := make([]*api.User, len(team.Members)) for i, member := range team.Members { members[i] = convert.ToUser(member, ctx.IsSigned, ctx.User.IsAdmin) } - ctx.JSON(200, members) + ctx.JSON(http.StatusOK, members) } // GetTeamMember api for get a particular member of team @@ -305,6 +315,9 @@ func GetTeamMember(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/User" + // "404": + // "$ref": "#/responses/notFound" + u := user.GetUserByParams(ctx) if ctx.Written() { return @@ -312,13 +325,13 @@ func GetTeamMember(ctx *context.APIContext) { teamID := ctx.ParamsInt64("teamid") isTeamMember, err := models.IsUserInTeams(u.ID, []int64{teamID}) if err != nil { - ctx.Error(500, "IsUserInTeams", err) + ctx.Error(http.StatusInternalServerError, "IsUserInTeams", err) return } else if !isTeamMember { ctx.NotFound() return } - ctx.JSON(200, convert.ToUser(u, ctx.IsSigned, ctx.User.IsAdmin)) + ctx.JSON(http.StatusOK, convert.ToUser(u, ctx.IsSigned, ctx.User.IsAdmin)) } // AddTeamMember api for add a member to a team @@ -343,15 +356,18 @@ func AddTeamMember(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "404": + // "$ref": "#/responses/notFound" + u := user.GetUserByParams(ctx) if ctx.Written() { return } if err := ctx.Org.Team.AddMember(u.ID); err != nil { - ctx.Error(500, "AddMember", err) + ctx.Error(http.StatusInternalServerError, "AddMember", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // RemoveTeamMember api for remove one member from a team @@ -376,16 +392,19 @@ func RemoveTeamMember(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "404": + // "$ref": "#/responses/notFound" + u := user.GetUserByParams(ctx) if ctx.Written() { return } if err := ctx.Org.Team.RemoveMember(u.ID); err != nil { - ctx.Error(500, "RemoveMember", err) + ctx.Error(http.StatusInternalServerError, "RemoveMember", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // GetTeamRepos api for get a team's repos @@ -405,20 +424,21 @@ func GetTeamRepos(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/RepositoryList" + team := ctx.Org.Team if err := team.GetRepositories(); err != nil { - ctx.Error(500, "GetTeamRepos", err) + ctx.Error(http.StatusInternalServerError, "GetTeamRepos", err) } repos := make([]*api.Repository, len(team.Repos)) for i, repo := range team.Repos { access, err := models.AccessLevel(ctx.User, repo) if err != nil { - ctx.Error(500, "GetTeamRepos", err) + ctx.Error(http.StatusInternalServerError, "GetTeamRepos", err) return } repos[i] = repo.APIFormat(access) } - ctx.JSON(200, repos) + ctx.JSON(http.StatusOK, repos) } // getRepositoryByParams get repository by a team's organization ID and repo name @@ -428,7 +448,7 @@ func getRepositoryByParams(ctx *context.APIContext) *models.Repository { if models.IsErrRepoNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetRepositoryByName", err) + ctx.Error(http.StatusInternalServerError, "GetRepositoryByName", err) } return nil } @@ -462,22 +482,25 @@ func AddTeamRepository(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + repo := getRepositoryByParams(ctx) if ctx.Written() { return } if access, err := models.AccessLevel(ctx.User, repo); err != nil { - ctx.Error(500, "AccessLevel", err) + ctx.Error(http.StatusInternalServerError, "AccessLevel", err) return } else if access < models.AccessModeAdmin { - ctx.Error(403, "", "Must have admin-level access to the repository") + ctx.Error(http.StatusForbidden, "", "Must have admin-level access to the repository") return } if err := ctx.Org.Team.AddRepository(repo); err != nil { - ctx.Error(500, "AddRepository", err) + ctx.Error(http.StatusInternalServerError, "AddRepository", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // RemoveTeamRepository api for removing a repository from a team @@ -509,22 +532,25 @@ func RemoveTeamRepository(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + repo := getRepositoryByParams(ctx) if ctx.Written() { return } if access, err := models.AccessLevel(ctx.User, repo); err != nil { - ctx.Error(500, "AccessLevel", err) + ctx.Error(http.StatusInternalServerError, "AccessLevel", err) return } else if access < models.AccessModeAdmin { - ctx.Error(403, "", "Must have admin-level access to the repository") + ctx.Error(http.StatusForbidden, "", "Must have admin-level access to the repository") return } if err := ctx.Org.Team.RemoveRepository(repo.ID); err != nil { - ctx.Error(500, "RemoveRepository", err) + ctx.Error(http.StatusInternalServerError, "RemoveRepository", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // SearchTeam api for searching teams @@ -568,6 +594,7 @@ func SearchTeam(ctx *context.APIContext) { // type: array // items: // "$ref": "#/definitions/Team" + opts := &models.SearchTeamOptions{ UserID: ctx.User.ID, Keyword: strings.TrimSpace(ctx.Query("q")), @@ -580,7 +607,7 @@ func SearchTeam(ctx *context.APIContext) { teams, _, err := models.SearchTeam(opts) if err != nil { log.Error("SearchTeam failed: %v", err) - ctx.JSON(500, map[string]interface{}{ + ctx.JSON(http.StatusInternalServerError, map[string]interface{}{ "ok": false, "error": "SearchTeam internal failure", }) @@ -591,7 +618,7 @@ func SearchTeam(ctx *context.APIContext) { for i := range teams { if err := teams[i].GetUnits(); err != nil { log.Error("Team GetUnits failed: %v", err) - ctx.JSON(500, map[string]interface{}{ + ctx.JSON(http.StatusInternalServerError, map[string]interface{}{ "ok": false, "error": "SearchTeam failed to get units", }) @@ -600,7 +627,7 @@ func SearchTeam(ctx *context.APIContext) { apiTeams[i] = convert.ToTeam(teams[i]) } - ctx.JSON(200, map[string]interface{}{ + ctx.JSON(http.StatusOK, map[string]interface{}{ "ok": true, "data": apiTeams, }) diff --git a/routers/api/v1/repo/blob.go b/routers/api/v1/repo/blob.go index d6265e16ce9bb..3918a49d5147c 100644 --- a/routers/api/v1/repo/blob.go +++ b/routers/api/v1/repo/blob.go @@ -37,6 +37,8 @@ func GetBlob(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/GitBlobResponse" + // "400": + // "$ref": "#/responses/error" sha := ctx.Params("sha") if len(sha) == 0 { diff --git a/routers/api/v1/repo/branch.go b/routers/api/v1/repo/branch.go index 9745903a95986..afc4763b522c4 100644 --- a/routers/api/v1/repo/branch.go +++ b/routers/api/v1/repo/branch.go @@ -6,6 +6,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" "code.gitea.io/gitea/modules/git" @@ -38,6 +40,7 @@ func GetBranch(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Branch" + if ctx.Repo.TreePath != "" { // if TreePath != "", then URL contained extra slashes // (i.e. "master/subbranch" instead of "master"), so branch does @@ -50,24 +53,24 @@ func GetBranch(ctx *context.APIContext) { if git.IsErrBranchNotExist(err) { ctx.NotFound(err) } else { - ctx.Error(500, "GetBranch", err) + ctx.Error(http.StatusInternalServerError, "GetBranch", err) } return } c, err := branch.GetCommit() if err != nil { - ctx.Error(500, "GetCommit", err) + ctx.Error(http.StatusInternalServerError, "GetCommit", err) return } branchProtection, err := ctx.Repo.Repository.GetBranchProtection(ctx.Repo.BranchName) if err != nil { - ctx.Error(500, "GetBranchProtection", err) + ctx.Error(http.StatusInternalServerError, "GetBranchProtection", err) return } - ctx.JSON(200, convert.ToBranch(ctx.Repo.Repository, branch, c, branchProtection, ctx.User)) + ctx.JSON(http.StatusOK, convert.ToBranch(ctx.Repo.Repository, branch, c, branchProtection, ctx.User)) } // ListBranches list all the branches of a repository @@ -91,9 +94,10 @@ func ListBranches(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/BranchList" + branches, err := ctx.Repo.Repository.GetBranches() if err != nil { - ctx.Error(500, "GetBranches", err) + ctx.Error(http.StatusInternalServerError, "GetBranches", err) return } @@ -101,16 +105,16 @@ func ListBranches(ctx *context.APIContext) { for i := range branches { c, err := branches[i].GetCommit() if err != nil { - ctx.Error(500, "GetCommit", err) + ctx.Error(http.StatusInternalServerError, "GetCommit", err) return } branchProtection, err := ctx.Repo.Repository.GetBranchProtection(branches[i].Name) if err != nil { - ctx.Error(500, "GetBranchProtection", err) + ctx.Error(http.StatusInternalServerError, "GetBranchProtection", err) return } apiBranches[i] = convert.ToBranch(ctx.Repo.Repository, branches[i], c, branchProtection, ctx.User) } - ctx.JSON(200, &apiBranches) + ctx.JSON(http.StatusOK, &apiBranches) } diff --git a/routers/api/v1/repo/collaborators.go b/routers/api/v1/repo/collaborators.go index 81d472dffb3aa..aec389ab310b9 100644 --- a/routers/api/v1/repo/collaborators.go +++ b/routers/api/v1/repo/collaborators.go @@ -7,6 +7,7 @@ package repo import ( "errors" + "net/http" "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" @@ -35,16 +36,17 @@ func ListCollaborators(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + collaborators, err := ctx.Repo.Repository.GetCollaborators() if err != nil { - ctx.Error(500, "ListCollaborators", err) + ctx.Error(http.StatusInternalServerError, "ListCollaborators", err) return } users := make([]*api.User, len(collaborators)) for i, collaborator := range collaborators { users[i] = convert.ToUser(collaborator.User, ctx.IsSigned, ctx.User != nil && ctx.User.IsAdmin) } - ctx.JSON(200, users) + ctx.JSON(http.StatusOK, users) } // IsCollaborator check if a user is a collaborator of a repository @@ -74,23 +76,26 @@ func IsCollaborator(ctx *context.APIContext) { // "204": // "$ref": "#/responses/empty" // "404": - // "$ref": "#/responses/empty" + // "$ref": "#/responses/notFound" + // "422": + // "$ref": "#/responses/validationError" + user, err := models.GetUserByName(ctx.Params(":collaborator")) if err != nil { if models.IsErrUserNotExist(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "GetUserByName", err) + ctx.Error(http.StatusInternalServerError, "GetUserByName", err) } return } isColab, err := ctx.Repo.Repository.IsCollaborator(user.ID) if err != nil { - ctx.Error(500, "IsCollaborator", err) + ctx.Error(http.StatusInternalServerError, "IsCollaborator", err) return } if isColab { - ctx.Status(204) + ctx.Status(http.StatusNoContent) } else { ctx.NotFound() } @@ -126,34 +131,37 @@ func AddCollaborator(ctx *context.APIContext, form api.AddCollaboratorOption) { // responses: // "204": // "$ref": "#/responses/empty" + // "422": + // "$ref": "#/responses/validationError" + collaborator, err := models.GetUserByName(ctx.Params(":collaborator")) if err != nil { if models.IsErrUserNotExist(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "GetUserByName", err) + ctx.Error(http.StatusInternalServerError, "GetUserByName", err) } return } if !collaborator.IsActive { - ctx.Error(500, "InactiveCollaborator", errors.New("collaborator's account is inactive")) + ctx.Error(http.StatusInternalServerError, "InactiveCollaborator", errors.New("collaborator's account is inactive")) return } if err := ctx.Repo.Repository.AddCollaborator(collaborator); err != nil { - ctx.Error(500, "AddCollaborator", err) + ctx.Error(http.StatusInternalServerError, "AddCollaborator", err) return } if form.Permission != nil { if err := ctx.Repo.Repository.ChangeCollaborationAccessMode(collaborator.ID, models.ParseAccessMode(*form.Permission)); err != nil { - ctx.Error(500, "ChangeCollaborationAccessMode", err) + ctx.Error(http.StatusInternalServerError, "ChangeCollaborationAccessMode", err) return } } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // DeleteCollaborator delete a collaborator from a repository @@ -182,19 +190,22 @@ func DeleteCollaborator(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "422": + // "$ref": "#/responses/validationError" + collaborator, err := models.GetUserByName(ctx.Params(":collaborator")) if err != nil { if models.IsErrUserNotExist(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "GetUserByName", err) + ctx.Error(http.StatusInternalServerError, "GetUserByName", err) } return } if err := ctx.Repo.Repository.DeleteCollaboration(collaborator.ID); err != nil { - ctx.Error(500, "DeleteCollaboration", err) + ctx.Error(http.StatusInternalServerError, "DeleteCollaboration", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/commits.go b/routers/api/v1/repo/commits.go index 163a06a95e8e1..d8777eaf3acaa 100644 --- a/routers/api/v1/repo/commits.go +++ b/routers/api/v1/repo/commits.go @@ -7,6 +7,7 @@ package repo import ( "math" + "net/http" "strconv" "time" @@ -64,7 +65,7 @@ func GetSingleCommit(ctx *context.APIContext) { return } - ctx.JSON(200, json) + ctx.JSON(http.StatusOK, json) } // GetAllCommits get all commits via @@ -102,7 +103,7 @@ func GetAllCommits(ctx *context.APIContext) { // "$ref": "#/responses/EmptyRepository" if ctx.Repo.Repository.IsEmpty { - ctx.JSON(409, api.APIError{ + ctx.JSON(http.StatusConflict, api.APIError{ Message: "Git Repository is empty.", URL: setting.API.SwaggerURL, }) @@ -188,7 +189,7 @@ func GetAllCommits(ctx *context.APIContext) { ctx.Header().Set("X-PageCount", strconv.Itoa(pageCount)) ctx.Header().Set("X-HasMore", strconv.FormatBool(page < pageCount)) - ctx.JSON(200, &apiCommits) + ctx.JSON(http.StatusOK, &apiCommits) } func toCommit(ctx *context.APIContext, repo *models.Repository, commit *git.Commit, userCache map[string]*models.User) (*api.Commit, error) { diff --git a/routers/api/v1/repo/file.go b/routers/api/v1/repo/file.go index 175235c5ef374..8cfe039df573a 100644 --- a/routers/api/v1/repo/file.go +++ b/routers/api/v1/repo/file.go @@ -43,6 +43,9 @@ func GetRawFile(ctx *context.APIContext) { // responses: // 200: // description: success + // "404": + // "$ref": "#/responses/notFound" + if ctx.Repo.Repository.IsEmpty { ctx.NotFound() return @@ -88,6 +91,9 @@ func GetArchive(ctx *context.APIContext) { // responses: // 200: // description: success + // "404": + // "$ref": "#/responses/notFound" + repoPath := models.RepoPath(ctx.Params(":username"), ctx.Params(":reponame")) gitRepo, err := git.OpenRepository(repoPath) if err != nil { @@ -126,6 +132,9 @@ func GetEditorconfig(ctx *context.APIContext) { // responses: // 200: // description: success + // "404": + // "$ref": "#/responses/notFound" + ec, err := ctx.Repo.GetEditorconfig() if err != nil { if git.IsErrNotExist(err) { @@ -332,6 +341,7 @@ func DeleteFile(ctx *context.APIContext, apiOpts api.DeleteFileOptions) { // responses: // "200": // "$ref": "#/responses/FileDeleteResponse" + if !CanWriteFiles(ctx.Repo) { ctx.Error(http.StatusInternalServerError, "DeleteFile", models.ErrUserDoesNotHaveAccessToRepo{ UserID: ctx.User.ID, diff --git a/routers/api/v1/repo/fork.go b/routers/api/v1/repo/fork.go index 31f2389478c76..0bf7fc6cefdf5 100644 --- a/routers/api/v1/repo/fork.go +++ b/routers/api/v1/repo/fork.go @@ -5,6 +5,9 @@ package repo import ( + "fmt" + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" api "code.gitea.io/gitea/modules/structs" @@ -32,21 +35,22 @@ func ListForks(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/RepositoryList" + forks, err := ctx.Repo.Repository.GetForks() if err != nil { - ctx.Error(500, "GetForks", err) + ctx.Error(http.StatusInternalServerError, "GetForks", err) return } apiForks := make([]*api.Repository, len(forks)) for i, fork := range forks { access, err := models.AccessLevel(ctx.User, fork) if err != nil { - ctx.Error(500, "AccessLevel", err) + ctx.Error(http.StatusInternalServerError, "AccessLevel", err) return } apiForks[i] = fork.APIFormat(access) } - ctx.JSON(200, apiForks) + ctx.JSON(http.StatusOK, apiForks) } // CreateFork create a fork of a repo @@ -74,6 +78,11 @@ func CreateFork(ctx *context.APIContext, form api.CreateForkOption) { // responses: // "202": // "$ref": "#/responses/Repository" + // "403": + // "$ref": "#/responses/forbidden" + // "422": + // "$ref": "#/responses/validationError" + repo := ctx.Repo.Repository var forker *models.User // user/org that will own the fork if form.Organization == nil { @@ -82,9 +91,9 @@ func CreateFork(ctx *context.APIContext, form api.CreateForkOption) { org, err := models.GetOrgByName(*form.Organization) if err != nil { if models.IsErrOrgNotExist(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "GetOrgByName", err) + ctx.Error(http.StatusInternalServerError, "GetOrgByName", err) } return } @@ -93,7 +102,7 @@ func CreateFork(ctx *context.APIContext, form api.CreateForkOption) { ctx.ServerError("IsOrgMember", err) return } else if !isMember { - ctx.Status(403) + ctx.Error(http.StatusForbidden, "isMemberNot", fmt.Sprintf("User is no Member of Organisation '%s'", org.Name)) return } forker = org @@ -101,9 +110,10 @@ func CreateFork(ctx *context.APIContext, form api.CreateForkOption) { fork, err := repo_service.ForkRepository(ctx.User, forker, repo, repo.Name, repo.Description) if err != nil { - ctx.Error(500, "ForkRepository", err) + ctx.Error(http.StatusInternalServerError, "ForkRepository", err) return } - ctx.JSON(202, fork.APIFormat(models.AccessModeOwner)) + //TODO change back to 201 + ctx.JSON(http.StatusAccepted, fork.APIFormat(models.AccessModeOwner)) } diff --git a/routers/api/v1/repo/git_hook.go b/routers/api/v1/repo/git_hook.go index 46651ef614065..0c538ac6b3196 100644 --- a/routers/api/v1/repo/git_hook.go +++ b/routers/api/v1/repo/git_hook.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" "code.gitea.io/gitea/modules/git" @@ -32,9 +34,10 @@ func ListGitHooks(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/GitHookList" + hooks, err := ctx.Repo.GitRepo.Hooks() if err != nil { - ctx.Error(500, "Hooks", err) + ctx.Error(http.StatusInternalServerError, "Hooks", err) return } @@ -42,7 +45,7 @@ func ListGitHooks(ctx *context.APIContext) { for i := range hooks { apiHooks[i] = convert.ToGitHook(hooks[i]) } - ctx.JSON(200, &apiHooks) + ctx.JSON(http.StatusOK, &apiHooks) } // GetGitHook get a repo's Git hook by id @@ -73,17 +76,18 @@ func GetGitHook(ctx *context.APIContext) { // "$ref": "#/responses/GitHook" // "404": // "$ref": "#/responses/notFound" + hookID := ctx.Params(":id") hook, err := ctx.Repo.GitRepo.GetHook(hookID) if err != nil { if err == git.ErrNotValidHook { ctx.NotFound() } else { - ctx.Error(500, "GetHook", err) + ctx.Error(http.StatusInternalServerError, "GetHook", err) } return } - ctx.JSON(200, convert.ToGitHook(hook)) + ctx.JSON(http.StatusOK, convert.ToGitHook(hook)) } // EditGitHook modify a Git hook of a repository @@ -118,24 +122,25 @@ func EditGitHook(ctx *context.APIContext, form api.EditGitHookOption) { // "$ref": "#/responses/GitHook" // "404": // "$ref": "#/responses/notFound" + hookID := ctx.Params(":id") hook, err := ctx.Repo.GitRepo.GetHook(hookID) if err != nil { if err == git.ErrNotValidHook { ctx.NotFound() } else { - ctx.Error(500, "GetHook", err) + ctx.Error(http.StatusInternalServerError, "GetHook", err) } return } hook.Content = form.Content if err = hook.Update(); err != nil { - ctx.Error(500, "hook.Update", err) + ctx.Error(http.StatusInternalServerError, "hook.Update", err) return } - ctx.JSON(200, convert.ToGitHook(hook)) + ctx.JSON(http.StatusOK, convert.ToGitHook(hook)) } // DeleteGitHook delete a Git hook of a repository @@ -166,22 +171,23 @@ func DeleteGitHook(ctx *context.APIContext) { // "$ref": "#/responses/empty" // "404": // "$ref": "#/responses/notFound" + hookID := ctx.Params(":id") hook, err := ctx.Repo.GitRepo.GetHook(hookID) if err != nil { if err == git.ErrNotValidHook { ctx.NotFound() } else { - ctx.Error(500, "GetHook", err) + ctx.Error(http.StatusInternalServerError, "GetHook", err) } return } hook.Content = "" if err = hook.Update(); err != nil { - ctx.Error(500, "hook.Update", err) + ctx.Error(http.StatusInternalServerError, "hook.Update", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/git_ref.go b/routers/api/v1/repo/git_ref.go index c2bcbb3603864..bd43ad4fc8ab8 100644 --- a/routers/api/v1/repo/git_ref.go +++ b/routers/api/v1/repo/git_ref.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/git" api "code.gitea.io/gitea/modules/structs" @@ -88,7 +90,7 @@ func getGitRefs(ctx *context.APIContext, filter string) ([]*git.Reference, strin func getGitRefsInternal(ctx *context.APIContext, filter string) { refs, lastMethodName, err := getGitRefs(ctx, filter) if err != nil { - ctx.Error(500, lastMethodName, err) + ctx.Error(http.StatusInternalServerError, lastMethodName, err) return } @@ -111,8 +113,8 @@ func getGitRefsInternal(ctx *context.APIContext, filter string) { } // If single reference is found and it matches filter exactly return it as object if len(apiRefs) == 1 && apiRefs[0].Ref == filter { - ctx.JSON(200, &apiRefs[0]) + ctx.JSON(http.StatusOK, &apiRefs[0]) return } - ctx.JSON(200, &apiRefs) + ctx.JSON(http.StatusOK, &apiRefs) } diff --git a/routers/api/v1/repo/hook.go b/routers/api/v1/repo/hook.go index 3666d79fa08bb..7fd7cd1be35cd 100644 --- a/routers/api/v1/repo/hook.go +++ b/routers/api/v1/repo/hook.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" @@ -35,9 +37,10 @@ func ListHooks(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/HookList" + hooks, err := models.GetWebhooksByRepoID(ctx.Repo.Repository.ID) if err != nil { - ctx.Error(500, "GetWebhooksByRepoID", err) + ctx.Error(http.StatusInternalServerError, "GetWebhooksByRepoID", err) return } @@ -45,7 +48,7 @@ func ListHooks(ctx *context.APIContext) { for i := range hooks { apiHooks[i] = convert.ToHook(ctx.Repo.RepoLink, hooks[i]) } - ctx.JSON(200, &apiHooks) + ctx.JSON(http.StatusOK, &apiHooks) } // GetHook get a repo's hook by id @@ -75,13 +78,16 @@ func GetHook(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Hook" + // "404": + // "$ref": "#/responses/notFound" + repo := ctx.Repo hookID := ctx.ParamsInt64(":id") hook, err := utils.GetRepoHook(ctx, repo.Repository.ID, hookID) if err != nil { return } - ctx.JSON(200, convert.ToHook(repo.RepoLink, hook)) + ctx.JSON(http.StatusOK, convert.ToHook(repo.RepoLink, hook)) } // TestHook tests a hook @@ -111,9 +117,10 @@ func TestHook(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + if ctx.Repo.Commit == nil { // if repo does not have any commits, then don't send a webhook - ctx.Status(204) + ctx.Status(http.StatusNoContent) return } @@ -134,11 +141,11 @@ func TestHook(ctx *context.APIContext) { Pusher: convert.ToUser(ctx.User, ctx.IsSigned, false), Sender: convert.ToUser(ctx.User, ctx.IsSigned, false), }); err != nil { - ctx.Error(500, "PrepareWebhook: ", err) + ctx.Error(http.StatusInternalServerError, "PrepareWebhook: ", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // CreateHook create a hook for a repository @@ -242,9 +249,9 @@ func DeleteHook(ctx *context.APIContext) { if models.IsErrWebhookNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "DeleteWebhookByRepoID", err) + ctx.Error(http.StatusInternalServerError, "DeleteWebhookByRepoID", err) } return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/issue.go b/routers/api/v1/repo/issue.go index 6972d447a6216..4396e6faaebe2 100644 --- a/routers/api/v1/repo/issue.go +++ b/routers/api/v1/repo/issue.go @@ -54,6 +54,7 @@ func SearchIssues(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/IssueList" + var isClosed util.OptionalBool switch ctx.Query("state") { case "closed": @@ -81,7 +82,7 @@ func SearchIssues(ctx *context.APIContext) { OrderBy: models.SearchOrderByRecentUpdated, }) if err != nil { - ctx.Error(500, "SearchRepositoryByName", err) + ctx.Error(http.StatusInternalServerError, "SearchRepositoryByName", err) return } @@ -119,7 +120,7 @@ func SearchIssues(ctx *context.APIContext) { if splitted := strings.Split(labels, ","); labels != "" && len(splitted) > 0 { labelIDs, err = models.GetLabelIDsInReposByNames(repoIDs, splitted) if err != nil { - ctx.Error(500, "GetLabelIDsInRepoByNames", err) + ctx.Error(http.StatusInternalServerError, "GetLabelIDsInRepoByNames", err) return } } @@ -140,7 +141,7 @@ func SearchIssues(ctx *context.APIContext) { } if err != nil { - ctx.Error(500, "Issues", err) + ctx.Error(http.StatusInternalServerError, "Issues", err) return } @@ -150,7 +151,7 @@ func SearchIssues(ctx *context.APIContext) { } ctx.SetLinkHeader(issueCount, setting.UI.IssuePagingNum) - ctx.JSON(200, &apiIssues) + ctx.JSON(http.StatusOK, &apiIssues) } // ListIssues list the issues of a repository @@ -190,6 +191,7 @@ func ListIssues(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/IssueList" + var isClosed util.OptionalBool switch ctx.Query("state") { case "closed": @@ -216,7 +218,7 @@ func ListIssues(ctx *context.APIContext) { if splitted := strings.Split(ctx.Query("labels"), ","); len(splitted) > 0 { labelIDs, err = models.GetLabelIDsInRepoByNames(ctx.Repo.Repository.ID, splitted) if err != nil { - ctx.Error(500, "GetLabelIDsInRepoByNames", err) + ctx.Error(http.StatusInternalServerError, "GetLabelIDsInRepoByNames", err) return } } @@ -235,7 +237,7 @@ func ListIssues(ctx *context.APIContext) { } if err != nil { - ctx.Error(500, "Issues", err) + ctx.Error(http.StatusInternalServerError, "Issues", err) return } @@ -245,7 +247,7 @@ func ListIssues(ctx *context.APIContext) { } ctx.SetLinkHeader(ctx.Repo.Repository.NumIssues, setting.UI.IssuePagingNum) - ctx.JSON(200, &apiIssues) + ctx.JSON(http.StatusOK, &apiIssues) } // GetIssue get an issue of a repository @@ -275,16 +277,19 @@ func GetIssue(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Issue" + // "404": + // "$ref": "#/responses/notFound" + issue, err := models.GetIssueWithAttrsByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } - ctx.JSON(200, issue.APIFormat()) + ctx.JSON(http.StatusOK, issue.APIFormat()) } // CreateIssue create an issue of a repository @@ -314,6 +319,12 @@ func CreateIssue(ctx *context.APIContext, form api.CreateIssueOption) { // responses: // "201": // "$ref": "#/responses/Issue" + // "403": + // "$ref": "#/responses/forbidden" + // "412": + // "$ref": "#/responses/error" + // "422": + // "$ref": "#/responses/validationError" var deadlineUnix timeutil.TimeStamp if form.Deadline != nil && ctx.Repo.CanWrite(models.UnitTypeIssues) { @@ -337,9 +348,9 @@ func CreateIssue(ctx *context.APIContext, form api.CreateIssueOption) { assigneeIDs, err = models.MakeIDsFromAPIAssigneesToAdd(form.Assignee, form.Assignees) if err != nil { if models.IsErrUserNotExist(err) { - ctx.Error(422, "", fmt.Sprintf("Assignee does not exist: [name: %s]", err)) + ctx.Error(http.StatusUnprocessableEntity, "", fmt.Sprintf("Assignee does not exist: [name: %s]", err)) } else { - ctx.Error(500, "AddAssigneeByName", err) + ctx.Error(http.StatusInternalServerError, "AddAssigneeByName", err) } return } @@ -348,17 +359,17 @@ func CreateIssue(ctx *context.APIContext, form api.CreateIssueOption) { for _, aID := range assigneeIDs { assignee, err := models.GetUserByID(aID) if err != nil { - ctx.Error(500, "GetUserByID", err) + ctx.Error(http.StatusInternalServerError, "GetUserByID", err) return } valid, err := models.CanBeAssigned(assignee, ctx.Repo.Repository, false) if err != nil { - ctx.Error(500, "canBeAssigned", err) + ctx.Error(http.StatusInternalServerError, "canBeAssigned", err) return } if !valid { - ctx.Error(422, "canBeAssigned", models.ErrUserDoesNotHaveAccessToRepo{UserID: aID, RepoName: ctx.Repo.Repository.Name}) + ctx.Error(http.StatusUnprocessableEntity, "canBeAssigned", models.ErrUserDoesNotHaveAccessToRepo{UserID: aID, RepoName: ctx.Repo.Repository.Name}) return } } @@ -369,10 +380,10 @@ func CreateIssue(ctx *context.APIContext, form api.CreateIssueOption) { if err := issue_service.NewIssue(ctx.Repo.Repository, issue, form.Labels, nil, assigneeIDs); err != nil { if models.IsErrUserDoesNotHaveAccessToRepo(err) { - ctx.Error(400, "UserDoesNotHaveAccessToRepo", err) + ctx.Error(http.StatusBadRequest, "UserDoesNotHaveAccessToRepo", err) return } - ctx.Error(500, "NewIssue", err) + ctx.Error(http.StatusInternalServerError, "NewIssue", err) return } @@ -382,7 +393,7 @@ func CreateIssue(ctx *context.APIContext, form api.CreateIssueOption) { ctx.Error(http.StatusPreconditionFailed, "DependenciesLeft", "cannot close this issue because it still has open dependencies") return } - ctx.Error(500, "ChangeStatus", err) + ctx.Error(http.StatusInternalServerError, "ChangeStatus", err) return } } @@ -390,10 +401,10 @@ func CreateIssue(ctx *context.APIContext, form api.CreateIssueOption) { // Refetch from database to assign some automatic values issue, err = models.GetIssueByID(issue.ID) if err != nil { - ctx.Error(500, "GetIssueByID", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByID", err) return } - ctx.JSON(201, issue.APIFormat()) + ctx.JSON(http.StatusCreated, issue.APIFormat()) } // EditIssue modify an issue of a repository @@ -429,12 +440,19 @@ func EditIssue(ctx *context.APIContext, form api.EditIssueOption) { // responses: // "201": // "$ref": "#/responses/Issue" + // "403": + // "$ref": "#/responses/forbidden" + // "404": + // "$ref": "#/responses/notFound" + // "412": + // "$ref": "#/responses/error" + issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } @@ -442,12 +460,12 @@ func EditIssue(ctx *context.APIContext, form api.EditIssueOption) { err = issue.LoadAttributes() if err != nil { - ctx.Error(500, "LoadAttributes", err) + ctx.Error(http.StatusInternalServerError, "LoadAttributes", err) return } if !issue.IsPoster(ctx.User.ID) && !ctx.Repo.CanWrite(models.UnitTypeIssues) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return } @@ -469,7 +487,7 @@ func EditIssue(ctx *context.APIContext, form api.EditIssueOption) { } if err := models.UpdateIssueDeadline(issue, deadlineUnix, ctx.User); err != nil { - ctx.Error(500, "UpdateIssueDeadline", err) + ctx.Error(http.StatusInternalServerError, "UpdateIssueDeadline", err) return } issue.DeadlineUnix = deadlineUnix @@ -491,7 +509,7 @@ func EditIssue(ctx *context.APIContext, form api.EditIssueOption) { err = issue_service.UpdateAssignees(issue, oneAssignee, form.Assignees, ctx.User) if err != nil { - ctx.Error(500, "UpdateAssignees", err) + ctx.Error(http.StatusInternalServerError, "UpdateAssignees", err) return } } @@ -501,13 +519,13 @@ func EditIssue(ctx *context.APIContext, form api.EditIssueOption) { oldMilestoneID := issue.MilestoneID issue.MilestoneID = *form.Milestone if err = issue_service.ChangeMilestoneAssign(issue, ctx.User, oldMilestoneID); err != nil { - ctx.Error(500, "ChangeMilestoneAssign", err) + ctx.Error(http.StatusInternalServerError, "ChangeMilestoneAssign", err) return } } if err = models.UpdateIssue(issue); err != nil { - ctx.Error(500, "UpdateIssue", err) + ctx.Error(http.StatusInternalServerError, "UpdateIssue", err) return } if form.State != nil { @@ -516,7 +534,7 @@ func EditIssue(ctx *context.APIContext, form api.EditIssueOption) { ctx.Error(http.StatusPreconditionFailed, "DependenciesLeft", "cannot close this issue because it still has open dependencies") return } - ctx.Error(500, "ChangeStatus", err) + ctx.Error(http.StatusInternalServerError, "ChangeStatus", err) return } } @@ -524,10 +542,10 @@ func EditIssue(ctx *context.APIContext, form api.EditIssueOption) { // Refetch from database to assign some automatic values issue, err = models.GetIssueByID(issue.ID) if err != nil { - ctx.Error(500, "GetIssueByID", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByID", err) return } - ctx.JSON(201, issue.APIFormat()) + ctx.JSON(http.StatusCreated, issue.APIFormat()) } // UpdateIssueDeadline updates an issue deadline @@ -564,22 +582,22 @@ func UpdateIssueDeadline(ctx *context.APIContext, form api.EditDeadlineOption) { // "201": // "$ref": "#/responses/IssueDeadline" // "403": - // description: Not repo writer + // "$ref": "#/responses/forbidden" // "404": - // description: Issue not found + // "$ref": "#/responses/notFound" issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } if !ctx.Repo.CanWrite(models.UnitTypeIssues) { - ctx.Status(403) + ctx.Error(http.StatusForbidden, "", "Not repo writer") return } @@ -592,9 +610,9 @@ func UpdateIssueDeadline(ctx *context.APIContext, form api.EditDeadlineOption) { } if err := models.UpdateIssueDeadline(issue, deadlineUnix, ctx.User); err != nil { - ctx.Error(500, "UpdateIssueDeadline", err) + ctx.Error(http.StatusInternalServerError, "UpdateIssueDeadline", err) return } - ctx.JSON(201, api.IssueDeadline{Deadline: &deadline}) + ctx.JSON(http.StatusCreated, api.IssueDeadline{Deadline: &deadline}) } diff --git a/routers/api/v1/repo/issue_comment.go b/routers/api/v1/repo/issue_comment.go index 3a5f6d24474f4..c13fc93cdfb73 100644 --- a/routers/api/v1/repo/issue_comment.go +++ b/routers/api/v1/repo/issue_comment.go @@ -6,6 +6,7 @@ package repo import ( "errors" + "net/http" "time" "code.gitea.io/gitea/models" @@ -45,6 +46,7 @@ func ListIssueComments(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/CommentList" + var since time.Time if len(ctx.Query("since")) > 0 { since, _ = time.Parse(time.RFC3339, ctx.Query("since")) @@ -53,7 +55,7 @@ func ListIssueComments(ctx *context.APIContext) { // comments,err:=models.GetCommentsByIssueIDSince(, since) issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { - ctx.Error(500, "GetRawIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetRawIssueByIndex", err) return } issue.Repo = ctx.Repo.Repository @@ -64,12 +66,12 @@ func ListIssueComments(ctx *context.APIContext) { Type: models.CommentTypeComment, }) if err != nil { - ctx.Error(500, "FindComments", err) + ctx.Error(http.StatusInternalServerError, "FindComments", err) return } if err := models.CommentList(comments).LoadPosters(); err != nil { - ctx.Error(500, "LoadPosters", err) + ctx.Error(http.StatusInternalServerError, "LoadPosters", err) return } @@ -78,7 +80,7 @@ func ListIssueComments(ctx *context.APIContext) { comment.Issue = issue apiComments[i] = comments[i].APIFormat() } - ctx.JSON(200, &apiComments) + ctx.JSON(http.StatusOK, &apiComments) } // ListRepoIssueComments returns all issue-comments for a repo @@ -106,6 +108,7 @@ func ListRepoIssueComments(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/CommentList" + var since time.Time if len(ctx.Query("since")) > 0 { since, _ = time.Parse(time.RFC3339, ctx.Query("since")) @@ -117,32 +120,32 @@ func ListRepoIssueComments(ctx *context.APIContext) { Type: models.CommentTypeComment, }) if err != nil { - ctx.Error(500, "FindComments", err) + ctx.Error(http.StatusInternalServerError, "FindComments", err) return } if err = models.CommentList(comments).LoadPosters(); err != nil { - ctx.Error(500, "LoadPosters", err) + ctx.Error(http.StatusInternalServerError, "LoadPosters", err) return } apiComments := make([]*api.Comment, len(comments)) if err := models.CommentList(comments).LoadIssues(); err != nil { - ctx.Error(500, "LoadIssues", err) + ctx.Error(http.StatusInternalServerError, "LoadIssues", err) return } if err := models.CommentList(comments).LoadPosters(); err != nil { - ctx.Error(500, "LoadPosters", err) + ctx.Error(http.StatusInternalServerError, "LoadPosters", err) return } if _, err := models.CommentList(comments).Issues().LoadRepositories(); err != nil { - ctx.Error(500, "LoadRepositories", err) + ctx.Error(http.StatusInternalServerError, "LoadRepositories", err) return } for i := range comments { apiComments[i] = comments[i].APIFormat() } - ctx.JSON(200, &apiComments) + ctx.JSON(http.StatusOK, &apiComments) } // CreateIssueComment create a comment for an issue @@ -178,24 +181,27 @@ func CreateIssueComment(ctx *context.APIContext, form api.CreateIssueCommentOpti // responses: // "201": // "$ref": "#/responses/Comment" + // "403": + // "$ref": "#/responses/forbidden" + issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) return } if issue.IsLocked && !ctx.Repo.CanWrite(models.UnitTypeIssues) && !ctx.User.IsAdmin { - ctx.Error(403, "CreateIssueComment", errors.New(ctx.Tr("repo.issues.comment_on_locked"))) + ctx.Error(http.StatusForbidden, "CreateIssueComment", errors.New(ctx.Tr("repo.issues.comment_on_locked"))) return } comment, err := comment_service.CreateIssueComment(ctx.User, ctx.Repo.Repository, issue, form.Body, nil) if err != nil { - ctx.Error(500, "CreateIssueComment", err) + ctx.Error(http.StatusInternalServerError, "CreateIssueComment", err) return } - ctx.JSON(201, comment.APIFormat()) + ctx.JSON(http.StatusCreated, comment.APIFormat()) } // EditIssueComment modify a comment of an issue @@ -273,6 +279,11 @@ func EditIssueCommentDeprecated(ctx *context.APIContext, form api.EditIssueComme // responses: // "200": // "$ref": "#/responses/Comment" + // "204": + // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + editIssueComment(ctx, form) } @@ -282,27 +293,27 @@ func editIssueComment(ctx *context.APIContext, form api.EditIssueCommentOption) if models.IsErrCommentNotExist(err) { ctx.NotFound(err) } else { - ctx.Error(500, "GetCommentByID", err) + ctx.Error(http.StatusInternalServerError, "GetCommentByID", err) } return } if !ctx.IsSigned || (ctx.User.ID != comment.PosterID && !ctx.Repo.IsAdmin()) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return } else if comment.Type != models.CommentTypeComment { - ctx.Status(204) + ctx.Status(http.StatusNoContent) return } oldContent := comment.Content comment.Content = form.Body if err := comment_service.UpdateComment(comment, ctx.User, oldContent); err != nil { - ctx.Error(500, "UpdateComment", err) + ctx.Error(http.StatusInternalServerError, "UpdateComment", err) return } - ctx.JSON(200, comment.APIFormat()) + ctx.JSON(http.StatusOK, comment.APIFormat()) } // DeleteIssueComment delete a comment from an issue @@ -330,6 +341,9 @@ func DeleteIssueComment(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + deleteIssueComment(ctx) } @@ -364,6 +378,9 @@ func DeleteIssueCommentDeprecated(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + deleteIssueComment(ctx) } @@ -373,23 +390,23 @@ func deleteIssueComment(ctx *context.APIContext) { if models.IsErrCommentNotExist(err) { ctx.NotFound(err) } else { - ctx.Error(500, "GetCommentByID", err) + ctx.Error(http.StatusInternalServerError, "GetCommentByID", err) } return } if !ctx.IsSigned || (ctx.User.ID != comment.PosterID && !ctx.Repo.IsAdmin()) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return } else if comment.Type != models.CommentTypeComment { - ctx.Status(204) + ctx.Status(http.StatusNoContent) return } if err = comment_service.DeleteComment(comment, ctx.User); err != nil { - ctx.Error(500, "DeleteCommentByID", err) + ctx.Error(http.StatusInternalServerError, "DeleteCommentByID", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/issue_label.go b/routers/api/v1/repo/issue_label.go index e41c1512e2cae..492da244f22ed 100644 --- a/routers/api/v1/repo/issue_label.go +++ b/routers/api/v1/repo/issue_label.go @@ -6,6 +6,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" api "code.gitea.io/gitea/modules/structs" @@ -41,18 +43,19 @@ func ListIssueLabels(ctx *context.APIContext) { // "$ref": "#/responses/LabelList" // "404": // "$ref": "#/responses/notFound" + issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } if err := issue.LoadAttributes(); err != nil { - ctx.Error(500, "LoadAttributes", err) + ctx.Error(http.StatusInternalServerError, "LoadAttributes", err) return } @@ -60,7 +63,7 @@ func ListIssueLabels(ctx *context.APIContext) { for i := range issue.Labels { apiLabels[i] = issue.Labels[i].APIFormat() } - ctx.JSON(200, &apiLabels) + ctx.JSON(http.StatusOK, &apiLabels) } // AddIssueLabels add labels for an issue @@ -96,35 +99,38 @@ func AddIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) { // responses: // "200": // "$ref": "#/responses/LabelList" + // "403": + // "$ref": "#/responses/forbidden" + issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } if !ctx.Repo.CanWriteIssuesOrPulls(issue.IsPull) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return } labels, err := models.GetLabelsInRepoByIDs(ctx.Repo.Repository.ID, form.Labels) if err != nil { - ctx.Error(500, "GetLabelsInRepoByIDs", err) + ctx.Error(http.StatusInternalServerError, "GetLabelsInRepoByIDs", err) return } if err = issue_service.AddLabels(issue, ctx.User, labels); err != nil { - ctx.Error(500, "AddLabels", err) + ctx.Error(http.StatusInternalServerError, "AddLabels", err) return } labels, err = models.GetLabelsByIssueID(issue.ID) if err != nil { - ctx.Error(500, "GetLabelsByIssueID", err) + ctx.Error(http.StatusInternalServerError, "GetLabelsByIssueID", err) return } @@ -132,7 +138,7 @@ func AddIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) { for i := range labels { apiLabels[i] = labels[i].APIFormat() } - ctx.JSON(200, &apiLabels) + ctx.JSON(http.StatusOK, &apiLabels) } // DeleteIssueLabel delete a label for an issue @@ -168,37 +174,42 @@ func DeleteIssueLabel(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + // "422": + // "$ref": "#/responses/validationError" + issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } if !ctx.Repo.CanWriteIssuesOrPulls(issue.IsPull) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return } label, err := models.GetLabelInRepoByID(ctx.Repo.Repository.ID, ctx.ParamsInt64(":id")) if err != nil { if models.IsErrLabelNotExist(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "GetLabelInRepoByID", err) + ctx.Error(http.StatusInternalServerError, "GetLabelInRepoByID", err) } return } if err := models.DeleteIssueLabel(issue, label, ctx.User); err != nil { - ctx.Error(500, "DeleteIssueLabel", err) + ctx.Error(http.StatusInternalServerError, "DeleteIssueLabel", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // ReplaceIssueLabels replace labels for an issue @@ -234,35 +245,38 @@ func ReplaceIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) { // responses: // "200": // "$ref": "#/responses/LabelList" + // "403": + // "$ref": "#/responses/forbidden" + issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } if !ctx.Repo.CanWriteIssuesOrPulls(issue.IsPull) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return } labels, err := models.GetLabelsInRepoByIDs(ctx.Repo.Repository.ID, form.Labels) if err != nil { - ctx.Error(500, "GetLabelsInRepoByIDs", err) + ctx.Error(http.StatusInternalServerError, "GetLabelsInRepoByIDs", err) return } if err := issue.ReplaceLabels(labels, ctx.User); err != nil { - ctx.Error(500, "ReplaceLabels", err) + ctx.Error(http.StatusInternalServerError, "ReplaceLabels", err) return } labels, err = models.GetLabelsByIssueID(issue.ID) if err != nil { - ctx.Error(500, "GetLabelsByIssueID", err) + ctx.Error(http.StatusInternalServerError, "GetLabelsByIssueID", err) return } @@ -270,7 +284,7 @@ func ReplaceIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) { for i := range labels { apiLabels[i] = labels[i].APIFormat() } - ctx.JSON(200, &apiLabels) + ctx.JSON(http.StatusOK, &apiLabels) } // ClearIssueLabels delete all the labels for an issue @@ -300,25 +314,28 @@ func ClearIssueLabels(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } if !ctx.Repo.CanWriteIssuesOrPulls(issue.IsPull) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return } if err := issue_service.ClearLabels(issue, ctx.User); err != nil { - ctx.Error(500, "ClearLabels", err) + ctx.Error(http.StatusInternalServerError, "ClearLabels", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/issue_reaction.go b/routers/api/v1/repo/issue_reaction.go index 56e12ccdcc3ca..4b06bb987c9fc 100644 --- a/routers/api/v1/repo/issue_reaction.go +++ b/routers/api/v1/repo/issue_reaction.go @@ -6,6 +6,7 @@ package repo import ( "errors" + "net/http" "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" @@ -41,29 +42,32 @@ func GetIssueCommentReactions(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/ReactionResponseList" + // "403": + // "$ref": "#/responses/forbidden" + comment, err := models.GetCommentByID(ctx.ParamsInt64(":id")) if err != nil { if models.IsErrCommentNotExist(err) { ctx.NotFound(err) } else { - ctx.Error(500, "GetCommentByID", err) + ctx.Error(http.StatusInternalServerError, "GetCommentByID", err) } return } if !ctx.Repo.CanRead(models.UnitTypeIssues) && !ctx.User.IsAdmin { - ctx.Error(403, "GetIssueCommentReactions", errors.New("no permission to get reactions")) + ctx.Error(http.StatusForbidden, "GetIssueCommentReactions", errors.New("no permission to get reactions")) return } reactions, err := models.FindCommentReactions(comment) if err != nil { - ctx.Error(500, "FindIssueReactions", err) + ctx.Error(http.StatusInternalServerError, "FindIssueReactions", err) return } _, err = reactions.LoadUsers() if err != nil { - ctx.Error(500, "ReactionList.LoadUsers()", err) + ctx.Error(http.StatusInternalServerError, "ReactionList.LoadUsers()", err) return } @@ -76,7 +80,7 @@ func GetIssueCommentReactions(ctx *context.APIContext) { }) } - ctx.JSON(200, result) + ctx.JSON(http.StatusOK, result) } // PostIssueCommentReaction add a reaction to a comment of a issue @@ -112,6 +116,9 @@ func PostIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOpti // responses: // "201": // "$ref": "#/responses/ReactionResponse" + // "403": + // "$ref": "#/responses/forbidden" + changeIssueCommentReaction(ctx, form, true) } @@ -148,6 +155,9 @@ func DeleteIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOp // responses: // "200": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + changeIssueCommentReaction(ctx, form, false) } @@ -157,18 +167,18 @@ func changeIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOp if models.IsErrCommentNotExist(err) { ctx.NotFound(err) } else { - ctx.Error(500, "GetCommentByID", err) + ctx.Error(http.StatusInternalServerError, "GetCommentByID", err) } return } err = comment.LoadIssue() if err != nil { - ctx.Error(500, "comment.LoadIssue() failed", err) + ctx.Error(http.StatusInternalServerError, "comment.LoadIssue() failed", err) } if comment.Issue.IsLocked && !ctx.Repo.CanWrite(models.UnitTypeIssues) && !ctx.User.IsAdmin { - ctx.Error(403, "ChangeIssueCommentReaction", errors.New("no permission to change reaction")) + ctx.Error(http.StatusForbidden, "ChangeIssueCommentReaction", errors.New("no permission to change reaction")) return } @@ -177,19 +187,19 @@ func changeIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOp reaction, err := models.CreateCommentReaction(ctx.User, comment.Issue, comment, form.Reaction) if err != nil { if models.IsErrForbiddenIssueReaction(err) { - ctx.Error(403, err.Error(), err) + ctx.Error(http.StatusForbidden, err.Error(), err) } else { - ctx.Error(500, "CreateCommentReaction", err) + ctx.Error(http.StatusInternalServerError, "CreateCommentReaction", err) } return } _, err = reaction.LoadUser() if err != nil { - ctx.Error(500, "Reaction.LoadUser()", err) + ctx.Error(http.StatusInternalServerError, "Reaction.LoadUser()", err) return } - ctx.JSON(201, api.ReactionResponse{ + ctx.JSON(http.StatusCreated, api.ReactionResponse{ User: reaction.User.APIFormat(), Reaction: reaction.Type, Created: reaction.CreatedUnix.AsTime(), @@ -198,10 +208,11 @@ func changeIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOp // DeleteIssueCommentReaction part err = models.DeleteCommentReaction(ctx.User, comment.Issue, comment, form.Reaction) if err != nil { - ctx.Error(500, "DeleteCommentReaction", err) + ctx.Error(http.StatusInternalServerError, "DeleteCommentReaction", err) return } - ctx.Status(200) + //ToDo respond 204 + ctx.Status(http.StatusOK) } } @@ -234,29 +245,32 @@ func GetIssueReactions(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/ReactionResponseList" + // "403": + // "$ref": "#/responses/forbidden" + issue, err := models.GetIssueWithAttrsByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } if !ctx.Repo.CanRead(models.UnitTypeIssues) && !ctx.User.IsAdmin { - ctx.Error(403, "GetIssueReactions", errors.New("no permission to get reactions")) + ctx.Error(http.StatusForbidden, "GetIssueReactions", errors.New("no permission to get reactions")) return } reactions, err := models.FindIssueReactions(issue) if err != nil { - ctx.Error(500, "FindIssueReactions", err) + ctx.Error(http.StatusInternalServerError, "FindIssueReactions", err) return } _, err = reactions.LoadUsers() if err != nil { - ctx.Error(500, "ReactionList.LoadUsers()", err) + ctx.Error(http.StatusInternalServerError, "ReactionList.LoadUsers()", err) return } @@ -269,7 +283,7 @@ func GetIssueReactions(ctx *context.APIContext) { }) } - ctx.JSON(200, result) + ctx.JSON(http.StatusOK, result) } // PostIssueReaction add a reaction to a comment of a issue @@ -305,6 +319,9 @@ func PostIssueReaction(ctx *context.APIContext, form api.EditReactionOption) { // responses: // "201": // "$ref": "#/responses/ReactionResponse" + // "403": + // "$ref": "#/responses/forbidden" + changeIssueReaction(ctx, form, true) } @@ -341,6 +358,9 @@ func DeleteIssueReaction(ctx *context.APIContext, form api.EditReactionOption) { // responses: // "200": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + changeIssueReaction(ctx, form, false) } @@ -350,13 +370,13 @@ func changeIssueReaction(ctx *context.APIContext, form api.EditReactionOption, i if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } if issue.IsLocked && !ctx.Repo.CanWrite(models.UnitTypeIssues) && !ctx.User.IsAdmin { - ctx.Error(403, "ChangeIssueCommentReaction", errors.New("no permission to change reaction")) + ctx.Error(http.StatusForbidden, "ChangeIssueCommentReaction", errors.New("no permission to change reaction")) return } @@ -365,19 +385,19 @@ func changeIssueReaction(ctx *context.APIContext, form api.EditReactionOption, i reaction, err := models.CreateIssueReaction(ctx.User, issue, form.Reaction) if err != nil { if models.IsErrForbiddenIssueReaction(err) { - ctx.Error(403, err.Error(), err) + ctx.Error(http.StatusForbidden, err.Error(), err) } else { - ctx.Error(500, "CreateCommentReaction", err) + ctx.Error(http.StatusInternalServerError, "CreateCommentReaction", err) } return } _, err = reaction.LoadUser() if err != nil { - ctx.Error(500, "Reaction.LoadUser()", err) + ctx.Error(http.StatusInternalServerError, "Reaction.LoadUser()", err) return } - ctx.JSON(201, api.ReactionResponse{ + ctx.JSON(http.StatusCreated, api.ReactionResponse{ User: reaction.User.APIFormat(), Reaction: reaction.Type, Created: reaction.CreatedUnix.AsTime(), @@ -386,9 +406,10 @@ func changeIssueReaction(ctx *context.APIContext, form api.EditReactionOption, i // DeleteIssueReaction part err = models.DeleteIssueReaction(ctx.User, issue, form.Reaction) if err != nil { - ctx.Error(500, "DeleteIssueReaction", err) + ctx.Error(http.StatusInternalServerError, "DeleteIssueReaction", err) return } - ctx.Status(200) + //ToDo respond 204 + ctx.Status(http.StatusOK) } } diff --git a/routers/api/v1/repo/issue_stopwatch.go b/routers/api/v1/repo/issue_stopwatch.go index 48b2f6498f0f8..3ffdf24404124 100644 --- a/routers/api/v1/repo/issue_stopwatch.go +++ b/routers/api/v1/repo/issue_stopwatch.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" ) @@ -41,20 +43,21 @@ func StartIssueStopwatch(ctx *context.APIContext) { // "403": // description: Not repo writer, user does not have rights to toggle stopwatch // "404": - // description: Issue not found + // "$ref": "#/responses/notFound" // "409": // description: Cannot start a stopwatch again if it already exists + issue, err := prepareIssueStopwatch(ctx, false) if err != nil { return } if err := models.CreateOrStopIssueStopwatch(ctx.User, issue); err != nil { - ctx.Error(500, "CreateOrStopIssueStopwatch", err) + ctx.Error(http.StatusInternalServerError, "CreateOrStopIssueStopwatch", err) return } - ctx.Status(201) + ctx.Status(http.StatusCreated) } // StopIssueStopwatch stops a stopwatch for the given issue. @@ -89,20 +92,21 @@ func StopIssueStopwatch(ctx *context.APIContext) { // "403": // description: Not repo writer, user does not have rights to toggle stopwatch // "404": - // description: Issue not found + // "$ref": "#/responses/notFound" // "409": // description: Cannot stop a non existent stopwatch + issue, err := prepareIssueStopwatch(ctx, true) if err != nil { return } if err := models.CreateOrStopIssueStopwatch(ctx.User, issue); err != nil { - ctx.Error(500, "CreateOrStopIssueStopwatch", err) + ctx.Error(http.StatusInternalServerError, "CreateOrStopIssueStopwatch", err) return } - ctx.Status(201) + ctx.Status(http.StatusCreated) } // DeleteIssueStopwatch delete a specific stopwatch @@ -137,20 +141,21 @@ func DeleteIssueStopwatch(ctx *context.APIContext) { // "403": // description: Not repo writer, user does not have rights to toggle stopwatch // "404": - // description: Issue not found + // "$ref": "#/responses/notFound" // "409": // description: Cannot cancel a non existent stopwatch + issue, err := prepareIssueStopwatch(ctx, true) if err != nil { return } if err := models.CancelStopwatch(ctx.User, issue); err != nil { - ctx.Error(500, "CancelStopwatch", err) + ctx.Error(http.StatusInternalServerError, "CancelStopwatch", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } func prepareIssueStopwatch(ctx *context.APIContext, shouldExist bool) (*models.Issue, error) { @@ -159,27 +164,27 @@ func prepareIssueStopwatch(ctx *context.APIContext, shouldExist bool) (*models.I if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return nil, err } if !ctx.Repo.CanWrite(models.UnitTypeIssues) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return nil, err } if !ctx.Repo.CanUseTimetracker(issue, ctx.User) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return nil, err } if models.StopwatchExists(ctx.User.ID, issue.ID) != shouldExist { if shouldExist { - ctx.Error(409, "StopwatchExists", "cannot stop/cancel a non existent stopwatch") + ctx.Error(http.StatusConflict, "StopwatchExists", "cannot stop/cancel a non existent stopwatch") } else { - ctx.Error(409, "StopwatchExists", "cannot start a stopwatch again if it already exists") + ctx.Error(http.StatusConflict, "StopwatchExists", "cannot start a stopwatch again if it already exists") } return nil, err } @@ -202,15 +207,15 @@ func GetStopwatches(ctx *context.APIContext) { sws, err := models.GetUserStopwatches(ctx.User.ID) if err != nil { - ctx.Error(500, "GetUserStopwatches", err) + ctx.Error(http.StatusInternalServerError, "GetUserStopwatches", err) return } apiSWs, err := sws.APIFormat() if err != nil { - ctx.Error(500, "APIFormat", err) + ctx.Error(http.StatusInternalServerError, "APIFormat", err) return } - ctx.JSON(200, apiSWs) + ctx.JSON(http.StatusOK, apiSWs) } diff --git a/routers/api/v1/repo/issue_subscription.go b/routers/api/v1/repo/issue_subscription.go index 2c5f75f1eca07..153b01de61d3b 100644 --- a/routers/api/v1/repo/issue_subscription.go +++ b/routers/api/v1/repo/issue_subscription.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" ) @@ -46,7 +48,8 @@ func AddIssueSubscription(ctx *context.APIContext) { // "304": // description: User can only subscribe itself if he is no admin // "404": - // description: Issue not found + // "$ref": "#/responses/notFound" + setIssueSubscription(ctx, true) } @@ -87,7 +90,8 @@ func DelIssueSubscription(ctx *context.APIContext) { // "304": // description: User can only subscribe itself if he is no admin // "404": - // description: Issue not found + // "$ref": "#/responses/notFound" + setIssueSubscription(ctx, false) } @@ -97,7 +101,7 @@ func setIssueSubscription(ctx *context.APIContext, watch bool) { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return @@ -108,7 +112,7 @@ func setIssueSubscription(ctx *context.APIContext, watch bool) { if models.IsErrUserNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetUserByName", err) + ctx.Error(http.StatusInternalServerError, "GetUserByName", err) } return @@ -116,16 +120,16 @@ func setIssueSubscription(ctx *context.APIContext, watch bool) { //only admin and user for itself can change subscription if user.ID != ctx.User.ID && !ctx.User.IsAdmin { - ctx.Error(403, "User", nil) + ctx.Error(http.StatusForbidden, "User", nil) return } if err := models.CreateOrUpdateIssueWatch(user.ID, issue.ID, watch); err != nil { - ctx.Error(500, "CreateOrUpdateIssueWatch", err) + ctx.Error(http.StatusInternalServerError, "CreateOrUpdateIssueWatch", err) return } - ctx.Status(201) + ctx.Status(http.StatusCreated) } // GetIssueSubscribers return subscribers of an issue @@ -158,13 +162,14 @@ func GetIssueSubscribers(ctx *context.APIContext) { // "200": // "$ref": "#/responses/UserList" // "404": - // description: Issue not found + // "$ref": "#/responses/notFound" + issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return @@ -172,15 +177,15 @@ func GetIssueSubscribers(ctx *context.APIContext) { iwl, err := models.GetIssueWatchers(issue.ID) if err != nil { - ctx.Error(500, "GetIssueWatchers", err) + ctx.Error(http.StatusInternalServerError, "GetIssueWatchers", err) return } users, err := iwl.LoadWatchUsers() if err != nil { - ctx.Error(500, "LoadWatchUsers", err) + ctx.Error(http.StatusInternalServerError, "LoadWatchUsers", err) return } - ctx.JSON(200, users.APIFormat()) + ctx.JSON(http.StatusOK, users.APIFormat()) } diff --git a/routers/api/v1/repo/issue_tracked_time.go b/routers/api/v1/repo/issue_tracked_time.go index c38ea05c363f7..0d3ca5c177dab 100644 --- a/routers/api/v1/repo/issue_tracked_time.go +++ b/routers/api/v1/repo/issue_tracked_time.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" api "code.gitea.io/gitea/modules/structs" @@ -45,6 +47,9 @@ func ListTrackedTimes(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/TrackedTimeList" + // "404": + // "$ref": "#/responses/notFound" + if !ctx.Repo.Repository.IsTimetrackerEnabled() { ctx.NotFound("Timetracker is disabled") return @@ -54,18 +59,18 @@ func ListTrackedTimes(ctx *context.APIContext) { if models.IsErrIssueNotExist(err) { ctx.NotFound(err) } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } trackedTimes, err := models.GetTrackedTimes(models.FindTrackedTimesOptions{IssueID: issue.ID}) if err != nil { - ctx.Error(500, "GetTrackedTimesByIssue", err) + ctx.Error(http.StatusInternalServerError, "GetTrackedTimesByIssue", err) return } apiTrackedTimes := trackedTimesToAPIFormat(trackedTimes) - ctx.JSON(200, &apiTrackedTimes) + ctx.JSON(http.StatusOK, &apiTrackedTimes) } // AddTime adds time manual to the given issue @@ -104,31 +109,32 @@ func AddTime(ctx *context.APIContext, form api.AddTimeOption) { // "400": // "$ref": "#/responses/error" // "403": - // "$ref": "#/responses/error" + // "$ref": "#/responses/forbidden" + issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound(err) } else { - ctx.Error(500, "GetIssueByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err) } return } if !ctx.Repo.CanUseTimetracker(issue, ctx.User) { if !ctx.Repo.Repository.IsTimetrackerEnabled() { - ctx.JSON(400, struct{ Message string }{Message: "time tracking disabled"}) + ctx.Error(http.StatusBadRequest, "", "time tracking disabled") return } - ctx.Status(403) + ctx.Status(http.StatusForbidden) return } trackedTime, err := models.AddTime(ctx.User, issue, form.Time) if err != nil { - ctx.Error(500, "AddTime", err) + ctx.Error(http.StatusInternalServerError, "AddTime", err) return } - ctx.JSON(200, trackedTime.APIFormat()) + ctx.JSON(http.StatusOK, trackedTime.APIFormat()) } // ListTrackedTimesByUser lists all tracked times of the user @@ -157,8 +163,11 @@ func ListTrackedTimesByUser(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/TrackedTimeList" + // "400": + // "$ref": "#/responses/error" + if !ctx.Repo.Repository.IsTimetrackerEnabled() { - ctx.JSON(400, struct{ Message string }{Message: "time tracking disabled"}) + ctx.Error(http.StatusBadRequest, "", "time tracking disabled") return } user, err := models.GetUserByName(ctx.Params(":timetrackingusername")) @@ -166,7 +175,7 @@ func ListTrackedTimesByUser(ctx *context.APIContext) { if models.IsErrUserNotExist(err) { ctx.NotFound(err) } else { - ctx.Error(500, "GetUserByName", err) + ctx.Error(http.StatusInternalServerError, "GetUserByName", err) } return } @@ -178,11 +187,11 @@ func ListTrackedTimesByUser(ctx *context.APIContext) { UserID: user.ID, RepositoryID: ctx.Repo.Repository.ID}) if err != nil { - ctx.Error(500, "GetTrackedTimesByUser", err) + ctx.Error(http.StatusInternalServerError, "GetTrackedTimesByUser", err) return } apiTrackedTimes := trackedTimesToAPIFormat(trackedTimes) - ctx.JSON(200, &apiTrackedTimes) + ctx.JSON(http.StatusOK, &apiTrackedTimes) } // ListTrackedTimesByRepository lists all tracked times of the repository @@ -206,18 +215,21 @@ func ListTrackedTimesByRepository(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/TrackedTimeList" + // "400": + // "$ref": "#/responses/error" + if !ctx.Repo.Repository.IsTimetrackerEnabled() { - ctx.JSON(400, struct{ Message string }{Message: "time tracking disabled"}) + ctx.Error(http.StatusBadRequest, "", "time tracking disabled") return } trackedTimes, err := models.GetTrackedTimes(models.FindTrackedTimesOptions{ RepositoryID: ctx.Repo.Repository.ID}) if err != nil { - ctx.Error(500, "GetTrackedTimesByUser", err) + ctx.Error(http.StatusInternalServerError, "GetTrackedTimesByUser", err) return } apiTrackedTimes := trackedTimesToAPIFormat(trackedTimes) - ctx.JSON(200, &apiTrackedTimes) + ctx.JSON(http.StatusOK, &apiTrackedTimes) } // ListMyTrackedTimes lists all tracked times of the current user @@ -230,11 +242,12 @@ func ListMyTrackedTimes(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/TrackedTimeList" + trackedTimes, err := models.GetTrackedTimes(models.FindTrackedTimesOptions{UserID: ctx.User.ID}) if err != nil { - ctx.Error(500, "GetTrackedTimesByUser", err) + ctx.Error(http.StatusInternalServerError, "GetTrackedTimesByUser", err) return } apiTrackedTimes := trackedTimesToAPIFormat(trackedTimes) - ctx.JSON(200, &apiTrackedTimes) + ctx.JSON(http.StatusOK, &apiTrackedTimes) } diff --git a/routers/api/v1/repo/key.go b/routers/api/v1/repo/key.go index 6b499d2fb1107..4ced8ec42fc1a 100644 --- a/routers/api/v1/repo/key.go +++ b/routers/api/v1/repo/key.go @@ -6,6 +6,7 @@ package repo import ( "fmt" + "net/http" "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" @@ -62,6 +63,7 @@ func ListDeployKeys(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/DeployKeyList" + var keys []*models.DeployKey var err error @@ -74,7 +76,7 @@ func ListDeployKeys(ctx *context.APIContext) { } if err != nil { - ctx.Error(500, "ListDeployKeys", err) + ctx.Error(http.StatusInternalServerError, "ListDeployKeys", err) return } @@ -82,7 +84,7 @@ func ListDeployKeys(ctx *context.APIContext) { apiKeys := make([]*api.DeployKey, len(keys)) for i := range keys { if err = keys[i].GetContent(); err != nil { - ctx.Error(500, "GetContent", err) + ctx.Error(http.StatusInternalServerError, "GetContent", err) return } apiKeys[i] = convert.ToDeployKey(apiLink, keys[i]) @@ -91,7 +93,7 @@ func ListDeployKeys(ctx *context.APIContext) { } } - ctx.JSON(200, &apiKeys) + ctx.JSON(http.StatusOK, &apiKeys) } // GetDeployKey get a deploy key by id @@ -121,18 +123,19 @@ func GetDeployKey(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/DeployKey" + key, err := models.GetDeployKeyByID(ctx.ParamsInt64(":id")) if err != nil { if models.IsErrDeployKeyNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetDeployKeyByID", err) + ctx.Error(http.StatusInternalServerError, "GetDeployKeyByID", err) } return } if err = key.GetContent(); err != nil { - ctx.Error(500, "GetContent", err) + ctx.Error(http.StatusInternalServerError, "GetContent", err) return } @@ -141,17 +144,17 @@ func GetDeployKey(ctx *context.APIContext) { if ctx.User.IsAdmin || ((ctx.Repo.Repository.ID == key.RepoID) && (ctx.User.ID == ctx.Repo.Owner.ID)) { apiKey, _ = appendPrivateInformation(apiKey, key, ctx.Repo.Repository) } - ctx.JSON(200, apiKey) + ctx.JSON(http.StatusOK, apiKey) } // HandleCheckKeyStringError handle check key error func HandleCheckKeyStringError(ctx *context.APIContext, err error) { if models.IsErrSSHDisabled(err) { - ctx.Error(422, "", "SSH is disabled") + ctx.Error(http.StatusUnprocessableEntity, "", "SSH is disabled") } else if models.IsErrKeyUnableVerify(err) { - ctx.Error(422, "", "Unable to verify key content") + ctx.Error(http.StatusUnprocessableEntity, "", "Unable to verify key content") } else { - ctx.Error(422, "", fmt.Errorf("Invalid key content: %v", err)) + ctx.Error(http.StatusUnprocessableEntity, "", fmt.Errorf("Invalid key content: %v", err)) } } @@ -159,13 +162,13 @@ func HandleCheckKeyStringError(ctx *context.APIContext, err error) { func HandleAddKeyError(ctx *context.APIContext, err error) { switch { case models.IsErrDeployKeyAlreadyExist(err): - ctx.Error(422, "", "This key has already been added to this repository") + ctx.Error(http.StatusUnprocessableEntity, "", "This key has already been added to this repository") case models.IsErrKeyAlreadyExist(err): - ctx.Error(422, "", "Key content has been used as non-deploy key") + ctx.Error(http.StatusUnprocessableEntity, "", "Key content has been used as non-deploy key") case models.IsErrKeyNameAlreadyUsed(err): - ctx.Error(422, "", "Key title has been used") + ctx.Error(http.StatusUnprocessableEntity, "", "Key title has been used") default: - ctx.Error(500, "AddKey", err) + ctx.Error(http.StatusInternalServerError, "AddKey", err) } } @@ -196,6 +199,9 @@ func CreateDeployKey(ctx *context.APIContext, form api.CreateKeyOption) { // responses: // "201": // "$ref": "#/responses/DeployKey" + // "422": + // "$ref": "#/responses/validationError" + content, err := models.CheckPublicKeyString(form.Key) if err != nil { HandleCheckKeyStringError(ctx, err) @@ -210,7 +216,7 @@ func CreateDeployKey(ctx *context.APIContext, form api.CreateKeyOption) { key.Content = content apiLink := composeDeployKeysAPILink(ctx.Repo.Owner.Name + "/" + ctx.Repo.Repository.Name) - ctx.JSON(201, convert.ToDeployKey(apiLink, key)) + ctx.JSON(http.StatusCreated, convert.ToDeployKey(apiLink, key)) } // DeleteDeploykey delete deploy key for a repository @@ -238,14 +244,17 @@ func DeleteDeploykey(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + if err := models.DeleteDeployKey(ctx.User, ctx.ParamsInt64(":id")); err != nil { if models.IsErrKeyAccessDenied(err) { - ctx.Error(403, "", "You do not have access to this key") + ctx.Error(http.StatusForbidden, "", "You do not have access to this key") } else { - ctx.Error(500, "DeleteDeployKey", err) + ctx.Error(http.StatusInternalServerError, "DeleteDeployKey", err) } return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/label.go b/routers/api/v1/repo/label.go index 33574c481e8ec..16c905878d9cb 100644 --- a/routers/api/v1/repo/label.go +++ b/routers/api/v1/repo/label.go @@ -6,6 +6,7 @@ package repo import ( + "net/http" "strconv" "code.gitea.io/gitea/models" @@ -34,9 +35,10 @@ func ListLabels(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/LabelList" + labels, err := models.GetLabelsByRepoID(ctx.Repo.Repository.ID, ctx.Query("sort")) if err != nil { - ctx.Error(500, "GetLabelsByRepoID", err) + ctx.Error(http.StatusInternalServerError, "GetLabelsByRepoID", err) return } @@ -44,7 +46,7 @@ func ListLabels(ctx *context.APIContext) { for i := range labels { apiLabels[i] = labels[i].APIFormat() } - ctx.JSON(200, &apiLabels) + ctx.JSON(http.StatusOK, &apiLabels) } // GetLabel get label by repository and label id @@ -74,6 +76,7 @@ func GetLabel(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Label" + var ( label *models.Label err error @@ -88,12 +91,12 @@ func GetLabel(ctx *context.APIContext) { if models.IsErrLabelNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetLabelByRepoID", err) + ctx.Error(http.StatusInternalServerError, "GetLabelByRepoID", err) } return } - ctx.JSON(200, label.APIFormat()) + ctx.JSON(http.StatusOK, label.APIFormat()) } // CreateLabel create a label for a repository @@ -123,6 +126,7 @@ func CreateLabel(ctx *context.APIContext, form api.CreateLabelOption) { // responses: // "201": // "$ref": "#/responses/Label" + label := &models.Label{ Name: form.Name, Color: form.Color, @@ -130,10 +134,10 @@ func CreateLabel(ctx *context.APIContext, form api.CreateLabelOption) { Description: form.Description, } if err := models.NewLabel(label); err != nil { - ctx.Error(500, "NewLabel", err) + ctx.Error(http.StatusInternalServerError, "NewLabel", err) return } - ctx.JSON(201, label.APIFormat()) + ctx.JSON(http.StatusCreated, label.APIFormat()) } // EditLabel modify a label for a repository @@ -169,12 +173,13 @@ func EditLabel(ctx *context.APIContext, form api.EditLabelOption) { // responses: // "200": // "$ref": "#/responses/Label" + label, err := models.GetLabelInRepoByID(ctx.Repo.Repository.ID, ctx.ParamsInt64(":id")) if err != nil { if models.IsErrLabelNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetLabelByRepoID", err) + ctx.Error(http.StatusInternalServerError, "GetLabelByRepoID", err) } return } @@ -192,7 +197,7 @@ func EditLabel(ctx *context.APIContext, form api.EditLabelOption) { ctx.ServerError("UpdateLabel", err) return } - ctx.JSON(200, label.APIFormat()) + ctx.JSON(http.StatusOK, label.APIFormat()) } // DeleteLabel delete a label for a repository @@ -220,10 +225,11 @@ func DeleteLabel(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + if err := models.DeleteLabel(ctx.Repo.Repository.ID, ctx.ParamsInt64(":id")); err != nil { - ctx.Error(500, "DeleteLabel", err) + ctx.Error(http.StatusInternalServerError, "DeleteLabel", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/milestone.go b/routers/api/v1/repo/milestone.go index 9bc73852ca939..a979e2b69b7ca 100644 --- a/routers/api/v1/repo/milestone.go +++ b/routers/api/v1/repo/milestone.go @@ -5,6 +5,7 @@ package repo import ( + "net/http" "time" "code.gitea.io/gitea/models" @@ -38,9 +39,10 @@ func ListMilestones(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/MilestoneList" + milestones, err := models.GetMilestonesByRepoID(ctx.Repo.Repository.ID, api.StateType(ctx.Query("state"))) if err != nil { - ctx.Error(500, "GetMilestonesByRepoID", err) + ctx.Error(http.StatusInternalServerError, "GetMilestonesByRepoID", err) return } @@ -48,7 +50,7 @@ func ListMilestones(ctx *context.APIContext) { for i := range milestones { apiMilestones[i] = milestones[i].APIFormat() } - ctx.JSON(200, &apiMilestones) + ctx.JSON(http.StatusOK, &apiMilestones) } // GetMilestone get a milestone for a repository @@ -78,16 +80,17 @@ func GetMilestone(ctx *context.APIContext) { // 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(500, "GetMilestoneByRepoID", err) + ctx.Error(http.StatusInternalServerError, "GetMilestoneByRepoID", err) } return } - ctx.JSON(200, milestone.APIFormat()) + ctx.JSON(http.StatusOK, milestone.APIFormat()) } // CreateMilestone create a milestone for a repository @@ -117,6 +120,7 @@ func CreateMilestone(ctx *context.APIContext, form api.CreateMilestoneOption) { // responses: // "201": // "$ref": "#/responses/Milestone" + if form.Deadline == nil { defaultDeadline, _ := time.ParseInLocation("2006-01-02", "9999-12-31", time.Local) form.Deadline = &defaultDeadline @@ -130,10 +134,10 @@ func CreateMilestone(ctx *context.APIContext, form api.CreateMilestoneOption) { } if err := models.NewMilestone(milestone); err != nil { - ctx.Error(500, "NewMilestone", err) + ctx.Error(http.StatusInternalServerError, "NewMilestone", err) return } - ctx.JSON(201, milestone.APIFormat()) + ctx.JSON(http.StatusCreated, milestone.APIFormat()) } // EditMilestone modify a milestone for a repository @@ -169,12 +173,13 @@ func EditMilestone(ctx *context.APIContext, form api.EditMilestoneOption) { // 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(500, "GetMilestoneByRepoID", err) + ctx.Error(http.StatusInternalServerError, "GetMilestoneByRepoID", err) } return } @@ -193,7 +198,7 @@ func EditMilestone(ctx *context.APIContext, form api.EditMilestoneOption) { ctx.ServerError("UpdateMilestone", err) return } - ctx.JSON(200, milestone.APIFormat()) + ctx.JSON(http.StatusOK, milestone.APIFormat()) } // DeleteMilestone delete a milestone for a repository @@ -221,9 +226,10 @@ func DeleteMilestone(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + if err := models.DeleteMilestoneByRepoID(ctx.Repo.Repository.ID, ctx.ParamsInt64(":id")); err != nil { - ctx.Error(500, "DeleteMilestoneByRepoID", err) + ctx.Error(http.StatusInternalServerError, "DeleteMilestoneByRepoID", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/pull.go b/routers/api/v1/repo/pull.go index 1c273b7dc94e4..0392eb8e8c480 100644 --- a/routers/api/v1/repo/pull.go +++ b/routers/api/v1/repo/pull.go @@ -70,6 +70,7 @@ func ListPullRequests(ctx *context.APIContext, form api.ListPullRequestsOptions) // responses: // "200": // "$ref": "#/responses/PullRequestList" + prs, maxResults, err := models.PullRequests(ctx.Repo.Repository.ID, &models.PullRequestsOptions{ Page: ctx.QueryInt("page"), State: ctx.QueryTrim("state"), @@ -79,33 +80,33 @@ func ListPullRequests(ctx *context.APIContext, form api.ListPullRequestsOptions) }) if err != nil { - ctx.Error(500, "PullRequests", err) + ctx.Error(http.StatusInternalServerError, "PullRequests", err) return } apiPrs := make([]*api.PullRequest, len(prs)) for i := range prs { if err = prs[i].LoadIssue(); err != nil { - ctx.Error(500, "LoadIssue", err) + ctx.Error(http.StatusInternalServerError, "LoadIssue", err) return } if err = prs[i].LoadAttributes(); err != nil { - ctx.Error(500, "LoadAttributes", err) + ctx.Error(http.StatusInternalServerError, "LoadAttributes", err) return } if err = prs[i].GetBaseRepo(); err != nil { - ctx.Error(500, "GetBaseRepo", err) + ctx.Error(http.StatusInternalServerError, "GetBaseRepo", err) return } if err = prs[i].GetHeadRepo(); err != nil { - ctx.Error(500, "GetHeadRepo", err) + ctx.Error(http.StatusInternalServerError, "GetHeadRepo", err) return } apiPrs[i] = prs[i].APIFormat() } ctx.SetLinkHeader(int(maxResults), models.ItemsPerPage) - ctx.JSON(200, &apiPrs) + ctx.JSON(http.StatusOK, &apiPrs) } // GetPullRequest returns a single PR based on index @@ -135,25 +136,26 @@ func GetPullRequest(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/PullRequest" + pr, err := models.GetPullRequestByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrPullRequestNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetPullRequestByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetPullRequestByIndex", err) } return } if err = pr.GetBaseRepo(); err != nil { - ctx.Error(500, "GetBaseRepo", err) + ctx.Error(http.StatusInternalServerError, "GetBaseRepo", err) return } if err = pr.GetHeadRepo(); err != nil { - ctx.Error(500, "GetHeadRepo", err) + ctx.Error(http.StatusInternalServerError, "GetHeadRepo", err) return } - ctx.JSON(200, pr.APIFormat()) + ctx.JSON(http.StatusOK, pr.APIFormat()) } // CreatePullRequest does what it says @@ -183,6 +185,11 @@ func CreatePullRequest(ctx *context.APIContext, form api.CreatePullRequestOption // responses: // "201": // "$ref": "#/responses/PullRequest" + // "409": + // "$ref": "#/responses/error" + // "422": + // "$ref": "#/responses/validationError" + var ( repo = ctx.Repo.Repository labelIDs []int64 @@ -201,7 +208,7 @@ func CreatePullRequest(ctx *context.APIContext, form api.CreatePullRequestOption existingPr, err := models.GetUnmergedPullRequest(headRepo.ID, ctx.Repo.Repository.ID, headBranch, baseBranch) if err != nil { if !models.IsErrPullRequestNotExist(err) { - ctx.Error(500, "GetUnmergedPullRequest", err) + ctx.Error(http.StatusInternalServerError, "GetUnmergedPullRequest", err) return } } else { @@ -213,14 +220,14 @@ func CreatePullRequest(ctx *context.APIContext, form api.CreatePullRequestOption HeadBranch: existingPr.HeadBranch, BaseBranch: existingPr.BaseBranch, } - ctx.Error(409, "GetUnmergedPullRequest", err) + ctx.Error(http.StatusConflict, "GetUnmergedPullRequest", err) return } if len(form.Labels) > 0 { labels, err := models.GetLabelsInRepoByIDs(ctx.Repo.Repository.ID, form.Labels) if err != nil { - ctx.Error(500, "GetLabelsInRepoByIDs", err) + ctx.Error(http.StatusInternalServerError, "GetLabelsInRepoByIDs", err) return } @@ -236,7 +243,7 @@ func CreatePullRequest(ctx *context.APIContext, form api.CreatePullRequestOption if models.IsErrMilestoneNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetMilestoneByRepoID", err) + ctx.Error(http.StatusInternalServerError, "GetMilestoneByRepoID", err) } return } @@ -275,9 +282,9 @@ func CreatePullRequest(ctx *context.APIContext, form api.CreatePullRequestOption assigneeIDs, err := models.MakeIDsFromAPIAssigneesToAdd(form.Assignee, form.Assignees) if err != nil { if models.IsErrUserNotExist(err) { - ctx.Error(422, "", fmt.Sprintf("Assignee does not exist: [name: %s]", err)) + ctx.Error(http.StatusUnprocessableEntity, "", fmt.Sprintf("Assignee does not exist: [name: %s]", err)) } else { - ctx.Error(500, "AddAssigneeByName", err) + ctx.Error(http.StatusInternalServerError, "AddAssigneeByName", err) } return } @@ -285,34 +292,34 @@ func CreatePullRequest(ctx *context.APIContext, form api.CreatePullRequestOption for _, aID := range assigneeIDs { assignee, err := models.GetUserByID(aID) if err != nil { - ctx.Error(500, "GetUserByID", err) + ctx.Error(http.StatusInternalServerError, "GetUserByID", err) return } valid, err := models.CanBeAssigned(assignee, repo, true) if err != nil { - ctx.Error(500, "canBeAssigned", err) + ctx.Error(http.StatusInternalServerError, "canBeAssigned", err) return } if !valid { - ctx.Error(422, "canBeAssigned", models.ErrUserDoesNotHaveAccessToRepo{UserID: aID, RepoName: repo.Name}) + ctx.Error(http.StatusUnprocessableEntity, "canBeAssigned", models.ErrUserDoesNotHaveAccessToRepo{UserID: aID, RepoName: repo.Name}) return } } if err := pull_service.NewPullRequest(repo, prIssue, labelIDs, []string{}, pr, assigneeIDs); err != nil { if models.IsErrUserDoesNotHaveAccessToRepo(err) { - ctx.Error(400, "UserDoesNotHaveAccessToRepo", err) + ctx.Error(http.StatusBadRequest, "UserDoesNotHaveAccessToRepo", err) return } - ctx.Error(500, "NewPullRequest", err) + ctx.Error(http.StatusInternalServerError, "NewPullRequest", err) return } notification.NotifyNewPullRequest(pr) log.Trace("Pull request created: %d/%d", repo.ID, prIssue.ID) - ctx.JSON(201, pr.APIFormat()) + ctx.JSON(http.StatusCreated, pr.APIFormat()) } // EditPullRequest does what it says @@ -348,12 +355,19 @@ func EditPullRequest(ctx *context.APIContext, form api.EditPullRequestOption) { // responses: // "201": // "$ref": "#/responses/PullRequest" + // "403": + // "$ref": "#/responses/forbidden" + // "412": + // "$ref": "#/responses/error" + // "422": + // "$ref": "#/responses/validationError" + pr, err := models.GetPullRequestByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrPullRequestNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetPullRequestByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetPullRequestByIndex", err) } return } @@ -367,7 +381,7 @@ func EditPullRequest(ctx *context.APIContext, form api.EditPullRequestOption) { issue.Repo = ctx.Repo.Repository if !issue.IsPoster(ctx.User.ID) && !ctx.Repo.CanWrite(models.UnitTypePullRequests) { - ctx.Status(403) + ctx.Status(http.StatusForbidden) return } @@ -388,7 +402,7 @@ func EditPullRequest(ctx *context.APIContext, form api.EditPullRequestOption) { } if err := models.UpdateIssueDeadline(issue, deadlineUnix, ctx.User); err != nil { - ctx.Error(500, "UpdateIssueDeadline", err) + ctx.Error(http.StatusInternalServerError, "UpdateIssueDeadline", err) return } issue.DeadlineUnix = deadlineUnix @@ -406,9 +420,9 @@ func EditPullRequest(ctx *context.APIContext, form api.EditPullRequestOption) { err = issue_service.UpdateAssignees(issue, form.Assignee, form.Assignees, ctx.User) if err != nil { if models.IsErrUserNotExist(err) { - ctx.Error(422, "", fmt.Sprintf("Assignee does not exist: [name: %s]", err)) + ctx.Error(http.StatusUnprocessableEntity, "", fmt.Sprintf("Assignee does not exist: [name: %s]", err)) } else { - ctx.Error(500, "UpdateAssignees", err) + ctx.Error(http.StatusInternalServerError, "UpdateAssignees", err) } return } @@ -419,7 +433,7 @@ func EditPullRequest(ctx *context.APIContext, form api.EditPullRequestOption) { oldMilestoneID := issue.MilestoneID issue.MilestoneID = form.Milestone if err = issue_service.ChangeMilestoneAssign(issue, ctx.User, oldMilestoneID); err != nil { - ctx.Error(500, "ChangeMilestoneAssign", err) + ctx.Error(http.StatusInternalServerError, "ChangeMilestoneAssign", err) return } } @@ -427,17 +441,17 @@ func EditPullRequest(ctx *context.APIContext, form api.EditPullRequestOption) { if ctx.Repo.CanWrite(models.UnitTypePullRequests) && form.Labels != nil { labels, err := models.GetLabelsInRepoByIDs(ctx.Repo.Repository.ID, form.Labels) if err != nil { - ctx.Error(500, "GetLabelsInRepoByIDsError", err) + ctx.Error(http.StatusInternalServerError, "GetLabelsInRepoByIDsError", err) return } if err = issue.ReplaceLabels(labels, ctx.User); err != nil { - ctx.Error(500, "ReplaceLabelsError", err) + ctx.Error(http.StatusInternalServerError, "ReplaceLabelsError", err) return } } if err = models.UpdateIssue(issue); err != nil { - ctx.Error(500, "UpdateIssue", err) + ctx.Error(http.StatusInternalServerError, "UpdateIssue", err) return } if form.State != nil { @@ -446,7 +460,7 @@ func EditPullRequest(ctx *context.APIContext, form api.EditPullRequestOption) { ctx.Error(http.StatusPreconditionFailed, "DependenciesLeft", "cannot close this pull request because it still has open dependencies") return } - ctx.Error(500, "ChangeStatus", err) + ctx.Error(http.StatusInternalServerError, "ChangeStatus", err) return } } @@ -457,13 +471,13 @@ func EditPullRequest(ctx *context.APIContext, form api.EditPullRequestOption) { if models.IsErrPullRequestNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetPullRequestByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetPullRequestByIndex", err) } return } // TODO this should be 200, not 201 - ctx.JSON(201, pr.APIFormat()) + ctx.JSON(http.StatusCreated, pr.APIFormat()) } // IsPullRequestMerged checks if a PR exists given an index @@ -495,18 +509,19 @@ func IsPullRequestMerged(ctx *context.APIContext) { // description: pull request has been merged // "404": // description: pull request has not been merged + pr, err := models.GetPullRequestByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrPullRequestNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetPullRequestByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetPullRequestByIndex", err) } return } if pr.HasMerged { - ctx.Status(204) + ctx.Status(http.StatusNoContent) } ctx.NotFound() } @@ -544,12 +559,15 @@ func MergePullRequest(ctx *context.APIContext, form auth.MergePullRequestForm) { // "$ref": "#/responses/empty" // "405": // "$ref": "#/responses/empty" + // "409": + // "$ref": "#/responses/error" + pr, err := models.GetPullRequestByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrPullRequestNotExist(err) { ctx.NotFound("GetPullRequestByIndex", err) } else { - ctx.Error(500, "GetPullRequestByIndex", err) + ctx.Error(http.StatusInternalServerError, "GetPullRequestByIndex", err) } return } @@ -569,7 +587,7 @@ func MergePullRequest(ctx *context.APIContext, form auth.MergePullRequestForm) { if ctx.IsSigned { // Update issue-user. if err = pr.Issue.ReadBy(ctx.User.ID); err != nil { - ctx.Error(500, "ReadBy", err) + ctx.Error(http.StatusInternalServerError, "ReadBy", err) return } } @@ -580,18 +598,18 @@ func MergePullRequest(ctx *context.APIContext, form auth.MergePullRequestForm) { } if !pr.CanAutoMerge() || pr.HasMerged || pr.IsWorkInProgress() { - ctx.Status(405) + ctx.Status(http.StatusMethodNotAllowed) return } isPass, err := pull_service.IsPullCommitStatusPass(pr) if err != nil { - ctx.Error(500, "IsPullCommitStatusPass", err) + ctx.Error(http.StatusInternalServerError, "IsPullCommitStatusPass", err) return } if !isPass && !ctx.IsUserRepoAdmin() { - ctx.Status(405) + ctx.Status(http.StatusMethodNotAllowed) return } @@ -616,7 +634,7 @@ func MergePullRequest(ctx *context.APIContext, form auth.MergePullRequestForm) { if err := pull_service.Merge(pr, ctx.User, ctx.Repo.GitRepo, models.MergeStyle(form.Do), message); err != nil { if models.IsErrInvalidMergeStyle(err) { - ctx.Status(405) + ctx.Status(http.StatusMethodNotAllowed) return } else if models.IsErrMergeConflicts(err) { conflictError := err.(models.ErrMergeConflicts) @@ -628,15 +646,15 @@ func MergePullRequest(ctx *context.APIContext, form auth.MergePullRequestForm) { conflictError := err.(models.ErrMergeUnrelatedHistories) ctx.JSON(http.StatusConflict, conflictError) } else if models.IsErrMergePushOutOfDate(err) { - ctx.Status(http.StatusConflict) + ctx.Error(http.StatusConflict, "Merge", "merge push out of date") return } - ctx.Error(500, "Merge", err) + ctx.Error(http.StatusInternalServerError, "Merge", err) return } log.Trace("Pull request merged: %d", pr.ID) - ctx.Status(200) + ctx.Status(http.StatusOK) } func parseCompareInfo(ctx *context.APIContext, form api.CreatePullRequestOption) (*models.User, *models.Repository, *git.Repository, *git.CompareInfo, string, string) { @@ -706,7 +724,7 @@ func parseCompareInfo(ctx *context.APIContext, form api.CreatePullRequestOption) } else { headGitRepo, err = git.OpenRepository(models.RepoPath(headUser.Name, headRepo.Name)) if err != nil { - ctx.Error(500, "OpenRepository", err) + ctx.Error(http.StatusInternalServerError, "OpenRepository", err) return nil, nil, nil, nil, "", "" } } @@ -759,7 +777,7 @@ func parseCompareInfo(ctx *context.APIContext, form api.CreatePullRequestOption) compareInfo, err := headGitRepo.GetCompareInfo(models.RepoPath(baseRepo.Owner.Name, baseRepo.Name), baseBranch, headBranch) if err != nil { headGitRepo.Close() - ctx.Error(500, "GetCompareInfo", err) + ctx.Error(http.StatusInternalServerError, "GetCompareInfo", err) return nil, nil, nil, nil, "", "" } diff --git a/routers/api/v1/repo/release.go b/routers/api/v1/repo/release.go index 8bcebf6b4098b..f94d6ba635566 100644 --- a/routers/api/v1/repo/release.go +++ b/routers/api/v1/repo/release.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/setting" @@ -39,10 +41,11 @@ func GetRelease(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Release" + id := ctx.ParamsInt64(":id") release, err := models.GetReleaseByID(id) if err != nil { - ctx.Error(500, "GetReleaseByID", err) + ctx.Error(http.StatusInternalServerError, "GetReleaseByID", err) return } if release.RepoID != ctx.Repo.Repository.ID { @@ -50,10 +53,10 @@ func GetRelease(ctx *context.APIContext) { return } if err := release.LoadAttributes(); err != nil { - ctx.Error(500, "LoadAttributes", err) + ctx.Error(http.StatusInternalServerError, "LoadAttributes", err) return } - ctx.JSON(200, release.APIFormat()) + ctx.JSON(http.StatusOK, release.APIFormat()) } func getPagesInfo(ctx *context.APIContext) (int, int) { @@ -99,24 +102,25 @@ func ListReleases(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/ReleaseList" + page, limit := getPagesInfo(ctx) releases, err := models.GetReleasesByRepoID(ctx.Repo.Repository.ID, models.FindReleasesOptions{ IncludeDrafts: ctx.Repo.AccessMode >= models.AccessModeWrite, IncludeTags: false, }, page, limit) if err != nil { - ctx.Error(500, "GetReleasesByRepoID", err) + ctx.Error(http.StatusInternalServerError, "GetReleasesByRepoID", err) return } rels := make([]*api.Release, len(releases)) for i, release := range releases { if err := release.LoadAttributes(); err != nil { - ctx.Error(500, "LoadAttributes", err) + ctx.Error(http.StatusInternalServerError, "LoadAttributes", err) return } rels[i] = release.APIFormat() } - ctx.JSON(200, rels) + ctx.JSON(http.StatusOK, rels) } // CreateRelease create a release @@ -146,6 +150,9 @@ func CreateRelease(ctx *context.APIContext, form api.CreateReleaseOption) { // responses: // "201": // "$ref": "#/responses/Release" + // "409": + // "$ref": "#/responses/error" + rel, err := models.GetRelease(ctx.Repo.Repository.ID, form.TagName) if err != nil { if !models.IsErrReleaseNotExist(err) { @@ -171,15 +178,15 @@ func CreateRelease(ctx *context.APIContext, form api.CreateReleaseOption) { } if err := releaseservice.CreateRelease(ctx.Repo.GitRepo, rel, nil); err != nil { if models.IsErrReleaseAlreadyExist(err) { - ctx.Status(409) + ctx.Error(http.StatusConflict, "ReleaseAlreadyExist", err) } else { - ctx.Error(500, "CreateRelease", err) + ctx.Error(http.StatusInternalServerError, "CreateRelease", err) } return } } else { if !rel.IsTag { - ctx.Status(409) + ctx.Error(http.StatusConflict, "GetRelease", "Release is has no Tag") return } @@ -197,7 +204,7 @@ func CreateRelease(ctx *context.APIContext, form api.CreateReleaseOption) { return } } - ctx.JSON(201, rel.APIFormat()) + ctx.JSON(http.StatusCreated, rel.APIFormat()) } // EditRelease edit a release @@ -233,10 +240,11 @@ func EditRelease(ctx *context.APIContext, form api.EditReleaseOption) { // responses: // "200": // "$ref": "#/responses/Release" + id := ctx.ParamsInt64(":id") rel, err := models.GetReleaseByID(id) if err != nil && !models.IsErrReleaseNotExist(err) { - ctx.Error(500, "GetReleaseByID", err) + ctx.Error(http.StatusInternalServerError, "GetReleaseByID", err) return } if err != nil && models.IsErrReleaseNotExist(err) || @@ -264,20 +272,20 @@ func EditRelease(ctx *context.APIContext, form api.EditReleaseOption) { rel.IsPrerelease = *form.IsPrerelease } if err := releaseservice.UpdateRelease(ctx.User, ctx.Repo.GitRepo, rel, nil); err != nil { - ctx.Error(500, "UpdateRelease", err) + ctx.Error(http.StatusInternalServerError, "UpdateRelease", err) return } rel, err = models.GetReleaseByID(id) if err != nil { - ctx.Error(500, "GetReleaseByID", err) + ctx.Error(http.StatusInternalServerError, "GetReleaseByID", err) return } if err := rel.LoadAttributes(); err != nil { - ctx.Error(500, "LoadAttributes", err) + ctx.Error(http.StatusInternalServerError, "LoadAttributes", err) return } - ctx.JSON(200, rel.APIFormat()) + ctx.JSON(http.StatusOK, rel.APIFormat()) } // DeleteRelease delete a release from a repository @@ -305,10 +313,11 @@ func DeleteRelease(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + id := ctx.ParamsInt64(":id") rel, err := models.GetReleaseByID(id) if err != nil && !models.IsErrReleaseNotExist(err) { - ctx.Error(500, "GetReleaseByID", err) + ctx.Error(http.StatusInternalServerError, "GetReleaseByID", err) return } if err != nil && models.IsErrReleaseNotExist(err) || @@ -317,8 +326,8 @@ func DeleteRelease(ctx *context.APIContext) { return } if err := releaseservice.DeleteReleaseByID(id, ctx.User, false); err != nil { - ctx.Error(500, "DeleteReleaseByID", err) + ctx.Error(http.StatusInternalServerError, "DeleteReleaseByID", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/release_attachment.go b/routers/api/v1/repo/release_attachment.go index c49e4d3e346ec..6ba6489e27705 100644 --- a/routers/api/v1/repo/release_attachment.go +++ b/routers/api/v1/repo/release_attachment.go @@ -5,6 +5,7 @@ package repo import ( + "net/http" "strings" "code.gitea.io/gitea/models" @@ -48,11 +49,12 @@ func GetReleaseAttachment(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Attachment" + releaseID := ctx.ParamsInt64(":id") attachID := ctx.ParamsInt64(":asset") attach, err := models.GetAttachmentByID(attachID) if err != nil { - ctx.Error(500, "GetAttachmentByID", err) + ctx.Error(http.StatusInternalServerError, "GetAttachmentByID", err) return } if attach.ReleaseID != releaseID { @@ -61,7 +63,7 @@ func GetReleaseAttachment(ctx *context.APIContext) { return } // FIXME Should prove the existence of the given repo, but results in unnecessary database requests - ctx.JSON(200, attach.APIFormat()) + ctx.JSON(http.StatusOK, attach.APIFormat()) } // ListReleaseAttachments lists all attachments of the release @@ -91,10 +93,11 @@ func ListReleaseAttachments(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/AttachmentList" + releaseID := ctx.ParamsInt64(":id") release, err := models.GetReleaseByID(releaseID) if err != nil { - ctx.Error(500, "GetReleaseByID", err) + ctx.Error(http.StatusInternalServerError, "GetReleaseByID", err) return } if release.RepoID != ctx.Repo.Repository.ID { @@ -102,10 +105,10 @@ func ListReleaseAttachments(ctx *context.APIContext) { return } if err := release.LoadAttributes(); err != nil { - ctx.Error(500, "LoadAttributes", err) + ctx.Error(http.StatusInternalServerError, "LoadAttributes", err) return } - ctx.JSON(200, release.APIFormat().Attachments) + ctx.JSON(http.StatusOK, release.APIFormat().Attachments) } // CreateReleaseAttachment creates an attachment and saves the given file @@ -147,6 +150,8 @@ func CreateReleaseAttachment(ctx *context.APIContext) { // responses: // "201": // "$ref": "#/responses/Attachment" + // "400": + // "$ref": "#/responses/error" // Check if attachments are enabled if !setting.AttachmentEnabled { @@ -158,14 +163,14 @@ func CreateReleaseAttachment(ctx *context.APIContext) { releaseID := ctx.ParamsInt64(":id") release, err := models.GetReleaseByID(releaseID) if err != nil { - ctx.Error(500, "GetReleaseByID", err) + ctx.Error(http.StatusInternalServerError, "GetReleaseByID", err) return } // Get uploaded file from request file, header, err := ctx.GetFile("attachment") if err != nil { - ctx.Error(500, "GetFile", err) + ctx.Error(http.StatusInternalServerError, "GetFile", err) return } defer file.Close() @@ -179,7 +184,7 @@ func CreateReleaseAttachment(ctx *context.APIContext) { // Check if the filetype is allowed by the settings err = upload.VerifyAllowedContentType(buf, strings.Split(setting.AttachmentAllowedTypes, ",")) if err != nil { - ctx.Error(400, "DetectContentType", err) + ctx.Error(http.StatusBadRequest, "DetectContentType", err) return } @@ -195,11 +200,11 @@ func CreateReleaseAttachment(ctx *context.APIContext) { ReleaseID: release.ID, }, buf, file) if err != nil { - ctx.Error(500, "NewAttachment", err) + ctx.Error(http.StatusInternalServerError, "NewAttachment", err) return } - ctx.JSON(201, attach.APIFormat()) + ctx.JSON(http.StatusCreated, attach.APIFormat()) } // EditReleaseAttachment updates the given attachment @@ -247,7 +252,7 @@ func EditReleaseAttachment(ctx *context.APIContext, form api.EditAttachmentOptio attachID := ctx.ParamsInt64(":asset") attach, err := models.GetAttachmentByID(attachID) if err != nil { - ctx.Error(500, "GetAttachmentByID", err) + ctx.Error(http.StatusInternalServerError, "GetAttachmentByID", err) return } if attach.ReleaseID != releaseID { @@ -261,9 +266,9 @@ func EditReleaseAttachment(ctx *context.APIContext, form api.EditAttachmentOptio } if err := models.UpdateAttachment(attach); err != nil { - ctx.Error(500, "UpdateAttachment", attach) + ctx.Error(http.StatusInternalServerError, "UpdateAttachment", attach) } - ctx.JSON(201, attach.APIFormat()) + ctx.JSON(http.StatusCreated, attach.APIFormat()) } // DeleteReleaseAttachment delete a given attachment @@ -305,7 +310,7 @@ func DeleteReleaseAttachment(ctx *context.APIContext) { attachID := ctx.ParamsInt64(":asset") attach, err := models.GetAttachmentByID(attachID) if err != nil { - ctx.Error(500, "GetAttachmentByID", err) + ctx.Error(http.StatusInternalServerError, "GetAttachmentByID", err) return } if attach.ReleaseID != releaseID { @@ -316,8 +321,8 @@ func DeleteReleaseAttachment(ctx *context.APIContext) { // FIXME Should prove the existence of the given repo, but results in unnecessary database requests if err := models.DeleteAttachment(attach, true); err != nil { - ctx.Error(500, "DeleteAttachment", err) + ctx.Error(http.StatusInternalServerError, "DeleteAttachment", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/repo/repo.go b/routers/api/v1/repo/repo.go index be226c3438860..8f34d8cca3f78 100644 --- a/routers/api/v1/repo/repo.go +++ b/routers/api/v1/repo/repo.go @@ -124,6 +124,7 @@ func Search(ctx *context.APIContext) { // "$ref": "#/responses/SearchResults" // "422": // "$ref": "#/responses/validationError" + opts := &models.SearchRepoOptions{ Keyword: strings.Trim(ctx.Query("q"), " "), OwnerID: ctx.QueryInt64("uid"), @@ -188,7 +189,7 @@ func Search(ctx *context.APIContext) { var err error repos, count, err := models.SearchRepository(opts) if err != nil { - ctx.JSON(500, api.SearchError{ + ctx.JSON(http.StatusInternalServerError, api.SearchError{ OK: false, Error: err.Error(), }) @@ -198,7 +199,7 @@ func Search(ctx *context.APIContext) { results := make([]*api.Repository, len(repos)) for i, repo := range repos { if err = repo.GetOwner(); err != nil { - ctx.JSON(500, api.SearchError{ + ctx.JSON(http.StatusInternalServerError, api.SearchError{ OK: false, Error: err.Error(), }) @@ -206,7 +207,7 @@ func Search(ctx *context.APIContext) { } accessMode, err := models.AccessLevel(ctx.User, repo) if err != nil { - ctx.JSON(500, api.SearchError{ + ctx.JSON(http.StatusInternalServerError, api.SearchError{ OK: false, Error: err.Error(), }) @@ -216,7 +217,7 @@ func Search(ctx *context.APIContext) { ctx.SetLinkHeader(int(count), setting.API.MaxResponseItems) ctx.Header().Set("X-Total-Count", fmt.Sprintf("%d", count)) - ctx.JSON(200, api.SearchResults{ + ctx.JSON(http.StatusOK, api.SearchResults{ OK: true, Data: results, }) @@ -239,17 +240,17 @@ func CreateUserRepo(ctx *context.APIContext, owner *models.User, opt api.CreateR }) if err != nil { if models.IsErrRepoAlreadyExist(err) { - ctx.Error(409, "", "The repository with the same name already exists.") + ctx.Error(http.StatusConflict, "", "The repository with the same name already exists.") } else if models.IsErrNameReserved(err) || models.IsErrNamePatternNotAllowed(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "CreateRepository", err) + ctx.Error(http.StatusInternalServerError, "CreateRepository", err) } return } - ctx.JSON(201, repo.APIFormat(models.AccessModeOwner)) + ctx.JSON(http.StatusCreated, repo.APIFormat(models.AccessModeOwner)) } // Create one repository of mine @@ -273,9 +274,10 @@ func Create(ctx *context.APIContext, opt api.CreateRepoOption) { // description: The repository with the same name already exists. // "422": // "$ref": "#/responses/validationError" + if ctx.User.IsOrganization() { // Shouldn't reach this condition, but just in case. - ctx.Error(422, "", "not allowed creating repository for organization") + ctx.Error(http.StatusUnprocessableEntity, "", "not allowed creating repository for organization") return } CreateUserRepo(ctx, ctx.User, opt) @@ -307,12 +309,13 @@ func CreateOrgRepo(ctx *context.APIContext, opt api.CreateRepoOption) { // "$ref": "#/responses/validationError" // "403": // "$ref": "#/responses/forbidden" + org, err := models.GetOrgByName(ctx.Params(":org")) if err != nil { if models.IsErrOrgNotExist(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "GetOrgByName", err) + ctx.Error(http.StatusInternalServerError, "GetOrgByName", err) } return } @@ -328,7 +331,7 @@ func CreateOrgRepo(ctx *context.APIContext, opt api.CreateRepoOption) { ctx.ServerError("CanCreateOrgRepo", err) return } else if !canCreate { - ctx.Error(403, "", "Given user is not allowed to create repository in organization.") + ctx.Error(http.StatusForbidden, "", "Given user is not allowed to create repository in organization.") return } } @@ -352,6 +355,11 @@ func Migrate(ctx *context.APIContext, form auth.MigrateRepoForm) { // responses: // "201": // "$ref": "#/responses/Repository" + // "403": + // "$ref": "#/responses/forbidden" + // "422": + // "$ref": "#/responses/validationError" + ctxUser := ctx.User // Not equal means context user is an organization, // or is another user/organization if current user is admin. @@ -359,9 +367,9 @@ func Migrate(ctx *context.APIContext, form auth.MigrateRepoForm) { org, err := models.GetUserByID(form.UID) if err != nil { if models.IsErrUserNotExist(err) { - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) } else { - ctx.Error(500, "GetUserByID", err) + ctx.Error(http.StatusInternalServerError, "GetUserByID", err) } return } @@ -369,13 +377,13 @@ func Migrate(ctx *context.APIContext, form auth.MigrateRepoForm) { } if ctx.HasError() { - ctx.Error(422, "", ctx.GetErrMsg()) + ctx.Error(http.StatusUnprocessableEntity, "", ctx.GetErrMsg()) return } if !ctx.User.IsAdmin { if !ctxUser.IsOrganization() && ctx.User.ID != ctxUser.ID { - ctx.Error(403, "", "Given user is not an organization.") + ctx.Error(http.StatusForbidden, "", "Given user is not an organization.") return } @@ -383,10 +391,10 @@ func Migrate(ctx *context.APIContext, form auth.MigrateRepoForm) { // Check ownership of organization. isOwner, err := ctxUser.IsOwnedBy(ctx.User.ID) if err != nil { - ctx.Error(500, "IsOwnedBy", err) + ctx.Error(http.StatusInternalServerError, "IsOwnedBy", err) return } else if !isOwner { - ctx.Error(403, "", "Given user is not owner of organization.") + ctx.Error(http.StatusForbidden, "", "Given user is not owner of organization.") return } } @@ -398,16 +406,16 @@ func Migrate(ctx *context.APIContext, form auth.MigrateRepoForm) { addrErr := err.(models.ErrInvalidCloneAddr) switch { case addrErr.IsURLError: - ctx.Error(422, "", err) + ctx.Error(http.StatusUnprocessableEntity, "", err) case addrErr.IsPermissionDenied: - ctx.Error(422, "", "You are not allowed to import local repositories.") + ctx.Error(http.StatusUnprocessableEntity, "", "You are not allowed to import local repositories.") case addrErr.IsInvalidPath: - ctx.Error(422, "", "Invalid local path, it does not exist or not a directory.") + ctx.Error(http.StatusUnprocessableEntity, "", "Invalid local path, it does not exist or not a directory.") default: - ctx.Error(500, "ParseRemoteAddr", "Unknown error type (ErrInvalidCloneAddr): "+err.Error()) + ctx.Error(http.StatusInternalServerError, "ParseRemoteAddr", "Unknown error type (ErrInvalidCloneAddr): "+err.Error()) } } else { - ctx.Error(500, "ParseRemoteAddr", err) + ctx.Error(http.StatusInternalServerError, "ParseRemoteAddr", err) } return } @@ -488,33 +496,33 @@ func Migrate(ctx *context.APIContext, form auth.MigrateRepoForm) { } log.Trace("Repository migrated: %s/%s", ctxUser.Name, form.RepoName) - ctx.JSON(201, repo.APIFormat(models.AccessModeAdmin)) + ctx.JSON(http.StatusCreated, repo.APIFormat(models.AccessModeAdmin)) } func handleMigrateError(ctx *context.APIContext, repoOwner *models.User, remoteAddr string, err error) { switch { case models.IsErrRepoAlreadyExist(err): - ctx.Error(409, "", "The repository with the same name already exists.") + ctx.Error(http.StatusConflict, "", "The repository with the same name already exists.") case migrations.IsRateLimitError(err): - ctx.Error(422, "", "Remote visit addressed rate limitation.") + ctx.Error(http.StatusUnprocessableEntity, "", "Remote visit addressed rate limitation.") case migrations.IsTwoFactorAuthError(err): - ctx.Error(422, "", "Remote visit required two factors authentication.") + ctx.Error(http.StatusUnprocessableEntity, "", "Remote visit required two factors authentication.") case models.IsErrReachLimitOfRepo(err): - ctx.Error(422, "", fmt.Sprintf("You have already reached your limit of %d repositories.", repoOwner.MaxCreationLimit())) + ctx.Error(http.StatusUnprocessableEntity, "", fmt.Sprintf("You have already reached your limit of %d repositories.", repoOwner.MaxCreationLimit())) case models.IsErrNameReserved(err): - ctx.Error(422, "", fmt.Sprintf("The username '%s' is reserved.", err.(models.ErrNameReserved).Name)) + ctx.Error(http.StatusUnprocessableEntity, "", fmt.Sprintf("The username '%s' is reserved.", err.(models.ErrNameReserved).Name)) case models.IsErrNamePatternNotAllowed(err): - ctx.Error(422, "", fmt.Sprintf("The pattern '%s' is not allowed in a username.", err.(models.ErrNamePatternNotAllowed).Pattern)) + ctx.Error(http.StatusUnprocessableEntity, "", fmt.Sprintf("The pattern '%s' is not allowed in a username.", err.(models.ErrNamePatternNotAllowed).Pattern)) default: err = util.URLSanitizedError(err, remoteAddr) if strings.Contains(err.Error(), "Authentication failed") || strings.Contains(err.Error(), "Bad credentials") || strings.Contains(err.Error(), "could not read Username") { - ctx.Error(422, "", fmt.Sprintf("Authentication failed: %v.", err)) + ctx.Error(http.StatusUnprocessableEntity, "", fmt.Sprintf("Authentication failed: %v.", err)) } else if strings.Contains(err.Error(), "fatal:") { - ctx.Error(422, "", fmt.Sprintf("Migration failed: %v.", err)) + ctx.Error(http.StatusUnprocessableEntity, "", fmt.Sprintf("Migration failed: %v.", err)) } else { - ctx.Error(500, "MigrateRepository", err) + ctx.Error(http.StatusInternalServerError, "MigrateRepository", err) } } } @@ -540,7 +548,8 @@ func Get(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Repository" - ctx.JSON(200, ctx.Repo.Repository.APIFormat(ctx.Repo.AccessMode)) + + ctx.JSON(http.StatusOK, ctx.Repo.Repository.APIFormat(ctx.Repo.AccessMode)) } // GetByID returns a single Repository @@ -560,25 +569,26 @@ func GetByID(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Repository" + repo, err := models.GetRepositoryByID(ctx.ParamsInt64(":id")) if err != nil { if models.IsErrRepoNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetRepositoryByID", err) + ctx.Error(http.StatusInternalServerError, "GetRepositoryByID", err) } return } perm, err := models.GetUserRepoPermission(repo, ctx.User) if err != nil { - ctx.Error(500, "AccessLevel", err) + ctx.Error(http.StatusInternalServerError, "AccessLevel", err) return } else if !perm.HasAccess() { ctx.NotFound() return } - ctx.JSON(200, repo.APIFormat(perm.AccessMode)) + ctx.JSON(http.StatusOK, repo.APIFormat(perm.AccessMode)) } // Edit edit repository properties @@ -612,6 +622,7 @@ func Edit(ctx *context.APIContext, opts api.EditRepoOption) { // "$ref": "#/responses/forbidden" // "422": // "$ref": "#/responses/validationError" + if err := updateBasicProperties(ctx, opts); err != nil { return } @@ -926,25 +937,26 @@ func Delete(ctx *context.APIContext) { // "$ref": "#/responses/empty" // "403": // "$ref": "#/responses/forbidden" + owner := ctx.Repo.Owner repo := ctx.Repo.Repository canDelete, err := repo.CanUserDelete(ctx.User) if err != nil { - ctx.Error(500, "CanUserDelete", err) + ctx.Error(http.StatusInternalServerError, "CanUserDelete", err) return } else if !canDelete { - ctx.Error(403, "", "Given user is not owner of organization.") + ctx.Error(http.StatusForbidden, "", "Given user is not owner of organization.") return } if err := repo_service.DeleteRepository(ctx.User, repo); err != nil { - ctx.Error(500, "DeleteRepository", err) + ctx.Error(http.StatusInternalServerError, "DeleteRepository", err) return } log.Trace("Repository deleted: %s/%s", owner.Name, repo.Name) - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // MirrorSync adds a mirrored repository to the sync queue @@ -968,13 +980,16 @@ func MirrorSync(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/empty" + // "403": + // "$ref": "#/responses/forbidden" + repo := ctx.Repo.Repository if !ctx.Repo.CanWrite(models.UnitTypeCode) { - ctx.Error(403, "MirrorSync", "Must have write access") + ctx.Error(http.StatusForbidden, "MirrorSync", "Must have write access") } mirror_service.StartToMirror(repo.ID) - ctx.Status(200) + ctx.Status(http.StatusOK) } diff --git a/routers/api/v1/repo/star.go b/routers/api/v1/repo/star.go index 8fe5b17c5f2ec..65a99d442abc5 100644 --- a/routers/api/v1/repo/star.go +++ b/routers/api/v1/repo/star.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" api "code.gitea.io/gitea/modules/structs" @@ -31,14 +33,15 @@ func ListStargazers(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + stargazers, err := ctx.Repo.Repository.GetStargazers(-1) if err != nil { - ctx.Error(500, "GetStargazers", err) + ctx.Error(http.StatusInternalServerError, "GetStargazers", err) return } users := make([]*api.User, len(stargazers)) for i, stargazer := range stargazers { users[i] = convert.ToUser(stargazer, ctx.IsSigned, ctx.User != nil && ctx.User.IsAdmin) } - ctx.JSON(200, users) + ctx.JSON(http.StatusOK, users) } diff --git a/routers/api/v1/repo/status.go b/routers/api/v1/repo/status.go index 7d4a2de389116..c137b64f5c821 100644 --- a/routers/api/v1/repo/status.go +++ b/routers/api/v1/repo/status.go @@ -6,6 +6,7 @@ package repo import ( "fmt" + "net/http" "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" @@ -43,9 +44,12 @@ func NewCommitStatus(ctx *context.APIContext, form api.CreateStatusOption) { // responses: // "201": // "$ref": "#/responses/Status" + // "400": + // "$ref": "#/responses/error" + sha := ctx.Params("sha") if len(sha) == 0 { - ctx.Error(400, "sha not given", nil) + ctx.Error(http.StatusBadRequest, "sha not given", nil) return } status := &models.CommitStatus{ @@ -55,11 +59,11 @@ func NewCommitStatus(ctx *context.APIContext, form api.CreateStatusOption) { Context: form.Context, } if err := repofiles.CreateCommitStatus(ctx.Repo.Repository, ctx.User, sha, status); err != nil { - ctx.Error(500, "CreateCommitStatus", err) + ctx.Error(http.StatusInternalServerError, "CreateCommitStatus", err) return } - ctx.JSON(201, status.APIFormat()) + ctx.JSON(http.StatusCreated, status.APIFormat()) } // GetCommitStatuses returns all statuses for any given commit hash @@ -105,6 +109,9 @@ func GetCommitStatuses(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/StatusList" + // "400": + // "$ref": "#/responses/error" + getCommitStatuses(ctx, ctx.Params("sha")) } @@ -151,17 +158,19 @@ func GetCommitStatusesByRef(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/StatusList" + // "400": + // "$ref": "#/responses/error" filter := ctx.Params("ref") if len(filter) == 0 { - ctx.Error(400, "ref not given", nil) + 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(500, lastMethodName, err) + ctx.Error(http.StatusInternalServerError, lastMethodName, err) return } if refSHA != "" { @@ -187,7 +196,7 @@ func searchRefCommitByType(ctx *context.APIContext, refType, filter string) (str func getCommitStatuses(ctx *context.APIContext, sha string) { if len(sha) == 0 { - ctx.Error(400, "ref/sha not given", nil) + ctx.Error(http.StatusBadRequest, "ref/sha not given", nil) return } repo := ctx.Repo.Repository @@ -198,7 +207,7 @@ func getCommitStatuses(ctx *context.APIContext, sha string) { State: ctx.QueryTrim("state"), }) if err != nil { - ctx.Error(500, "GetCommitStatuses", fmt.Errorf("GetCommitStatuses[%s, %s, %d]: %v", repo.FullName(), sha, ctx.QueryInt("page"), err)) + ctx.Error(http.StatusInternalServerError, "GetCommitStatuses", fmt.Errorf("GetCommitStatuses[%s, %s, %d]: %v", repo.FullName(), sha, ctx.QueryInt("page"), err)) return } @@ -207,7 +216,7 @@ func getCommitStatuses(ctx *context.APIContext, sha string) { apiStatuses = append(apiStatuses, status.APIFormat()) } - ctx.JSON(200, apiStatuses) + ctx.JSON(http.StatusOK, apiStatuses) } type combinedCommitStatus struct { @@ -251,9 +260,12 @@ func GetCombinedCommitStatusByRef(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/Status" + // "400": + // "$ref": "#/responses/error" + sha := ctx.Params("ref") if len(sha) == 0 { - ctx.Error(400, "ref/sha not given", nil) + ctx.Error(http.StatusBadRequest, "ref/sha not given", nil) return } repo := ctx.Repo.Repository @@ -262,12 +274,12 @@ func GetCombinedCommitStatusByRef(ctx *context.APIContext) { statuses, err := models.GetLatestCommitStatus(repo, sha, page) if err != nil { - ctx.Error(500, "GetLatestCommitStatus", fmt.Errorf("GetLatestCommitStatus[%s, %s, %d]: %v", repo.FullName(), sha, page, err)) + ctx.Error(http.StatusInternalServerError, "GetLatestCommitStatus", fmt.Errorf("GetLatestCommitStatus[%s, %s, %d]: %v", repo.FullName(), sha, page, err)) return } if len(statuses) == 0 { - ctx.Status(200) + ctx.Status(http.StatusOK) return } @@ -286,5 +298,5 @@ func GetCombinedCommitStatusByRef(ctx *context.APIContext) { } } - ctx.JSON(200, retStatus) + ctx.JSON(http.StatusOK, retStatus) } diff --git a/routers/api/v1/repo/subscriber.go b/routers/api/v1/repo/subscriber.go index 0e576b4ff0f5c..352f842884ac0 100644 --- a/routers/api/v1/repo/subscriber.go +++ b/routers/api/v1/repo/subscriber.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" api "code.gitea.io/gitea/modules/structs" @@ -31,14 +33,15 @@ func ListSubscribers(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + subscribers, err := ctx.Repo.Repository.GetWatchers(0) if err != nil { - ctx.Error(500, "GetWatchers", err) + ctx.Error(http.StatusInternalServerError, "GetWatchers", err) return } users := make([]*api.User, len(subscribers)) for i, subscriber := range subscribers { users[i] = convert.ToUser(subscriber, ctx.IsSigned, ctx.User != nil && ctx.User.IsAdmin) } - ctx.JSON(200, users) + ctx.JSON(http.StatusOK, users) } diff --git a/routers/api/v1/repo/tag.go b/routers/api/v1/repo/tag.go index 0a764113ab805..eb99895c64476 100644 --- a/routers/api/v1/repo/tag.go +++ b/routers/api/v1/repo/tag.go @@ -33,9 +33,10 @@ func ListTags(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/TagList" + tags, err := ctx.Repo.GitRepo.GetTagInfos() if err != nil { - ctx.Error(500, "GetTags", err) + ctx.Error(http.StatusInternalServerError, "GetTags", err) return } @@ -44,7 +45,7 @@ func ListTags(ctx *context.APIContext) { apiTags[i] = convert.ToTag(ctx.Repo.Repository, tags[i]) } - ctx.JSON(200, &apiTags) + ctx.JSON(http.StatusOK, &apiTags) } // GetTag get the tag of a repository. @@ -73,6 +74,8 @@ func GetTag(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/AnnotatedTag" + // "400": + // "$ref": "#/responses/error" sha := ctx.Params("sha") if len(sha) == 0 { diff --git a/routers/api/v1/repo/topic.go b/routers/api/v1/repo/topic.go index 1656fd1b16c76..0c56f2a769628 100644 --- a/routers/api/v1/repo/topic.go +++ b/routers/api/v1/repo/topic.go @@ -42,9 +42,7 @@ func ListTopics(ctx *context.APIContext) { }) if err != nil { log.Error("ListTopics failed: %v", err) - ctx.JSON(http.StatusInternalServerError, map[string]interface{}{ - "message": "ListTopics failed.", - }) + ctx.InternalServerError(err) return } @@ -82,6 +80,8 @@ func UpdateTopics(ctx *context.APIContext, form api.RepoTopicOptions) { // responses: // "204": // "$ref": "#/responses/empty" + // "422": + // "$ref": "#/responses/invalidTopicsError" topicNames := form.Topics validTopics, invalidTopics := models.SanitizeAndValidateTopics(topicNames) @@ -105,9 +105,7 @@ func UpdateTopics(ctx *context.APIContext, form api.RepoTopicOptions) { err := models.SaveTopics(ctx.Repo.Repository.ID, validTopics...) if err != nil { log.Error("SaveTopics failed: %v", err) - ctx.JSON(http.StatusInternalServerError, map[string]interface{}{ - "message": "Save topics failed.", - }) + ctx.InternalServerError(err) return } @@ -140,11 +138,16 @@ func AddTopic(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "422": + // "$ref": "#/responses/invalidTopicsError" topicName := strings.TrimSpace(strings.ToLower(ctx.Params(":topic"))) if !models.ValidateTopic(topicName) { - ctx.Error(http.StatusUnprocessableEntity, "", "Topic name is invalid") + ctx.JSON(http.StatusUnprocessableEntity, map[string]interface{}{ + "invalidTopics": topicName, + "message": "Topic name is invalid", + }) return } @@ -154,9 +157,7 @@ func AddTopic(ctx *context.APIContext) { }) if err != nil { log.Error("AddTopic failed: %v", err) - ctx.JSON(http.StatusInternalServerError, map[string]interface{}{ - "message": "ListTopics failed.", - }) + ctx.InternalServerError(err) return } if len(topics) >= 25 { @@ -169,9 +170,7 @@ func AddTopic(ctx *context.APIContext) { _, err = models.AddTopic(ctx.Repo.Repository.ID, topicName) if err != nil { log.Error("AddTopic failed: %v", err) - ctx.JSON(http.StatusInternalServerError, map[string]interface{}{ - "message": "AddTopic failed.", - }) + ctx.InternalServerError(err) return } @@ -204,19 +203,23 @@ func DeleteTopic(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + // "422": + // "$ref": "#/responses/invalidTopicsError" + topicName := strings.TrimSpace(strings.ToLower(ctx.Params(":topic"))) if !models.ValidateTopic(topicName) { - ctx.Error(http.StatusUnprocessableEntity, "", "Topic name is invalid") + ctx.JSON(http.StatusUnprocessableEntity, map[string]interface{}{ + "invalidTopics": topicName, + "message": "Topic name is invalid", + }) return } topic, err := models.DeleteTopic(ctx.Repo.Repository.ID, topicName) if err != nil { log.Error("DeleteTopic failed: %v", err) - ctx.JSON(http.StatusInternalServerError, map[string]interface{}{ - "message": "DeleteTopic failed.", - }) + ctx.InternalServerError(err) return } @@ -243,10 +246,11 @@ func TopicSearch(ctx *context.Context) { // responses: // "200": // "$ref": "#/responses/TopicListResponse" + // "403": + // "$ref": "#/responses/forbidden" + if ctx.User == nil { - ctx.JSON(http.StatusForbidden, map[string]interface{}{ - "message": "Only owners could change the topics.", - }) + ctx.Error(http.StatusForbidden, "UserIsNil", "Only owners could change the topics.") return } @@ -258,9 +262,7 @@ func TopicSearch(ctx *context.Context) { }) if err != nil { log.Error("SearchTopics failed: %v", err) - ctx.JSON(http.StatusInternalServerError, map[string]interface{}{ - "message": "Search topics failed.", - }) + ctx.InternalServerError(err) return } diff --git a/routers/api/v1/repo/tree.go b/routers/api/v1/repo/tree.go index 066ca662f84bc..987f2fb808768 100644 --- a/routers/api/v1/repo/tree.go +++ b/routers/api/v1/repo/tree.go @@ -5,6 +5,8 @@ package repo import ( + "net/http" + "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/repofiles" ) @@ -50,15 +52,17 @@ func GetTree(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/GitTreeResponse" + // "400": + // "$ref": "#/responses/error" sha := ctx.Params(":sha") if len(sha) == 0 { - ctx.Error(400, "", "sha not provided") + ctx.Error(http.StatusBadRequest, "", "sha not provided") return } if tree, err := repofiles.GetTreeBySHA(ctx.Repo.Repository, sha, ctx.QueryInt("page"), ctx.QueryInt("per_page"), ctx.QueryBool("recursive")); err != nil { - ctx.Error(400, "", err.Error()) + ctx.Error(http.StatusBadRequest, "", err.Error()) } else { - ctx.JSON(200, tree) + ctx.JSON(http.StatusOK, tree) } } diff --git a/routers/api/v1/user/app.go b/routers/api/v1/user/app.go index 1123dadfd4eb2..ec52f02d38659 100644 --- a/routers/api/v1/user/app.go +++ b/routers/api/v1/user/app.go @@ -6,6 +6,8 @@ package user import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" api "code.gitea.io/gitea/modules/structs" @@ -27,9 +29,10 @@ func ListAccessTokens(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/AccessTokenList" + tokens, err := models.ListAccessTokens(ctx.User.ID) if err != nil { - ctx.Error(500, "ListAccessTokens", err) + ctx.Error(http.StatusInternalServerError, "ListAccessTokens", err) return } @@ -41,7 +44,7 @@ func ListAccessTokens(ctx *context.APIContext) { TokenLastEight: tokens[i].TokenLastEight, } } - ctx.JSON(200, &apiTokens) + ctx.JSON(http.StatusOK, &apiTokens) } // CreateAccessToken create access tokens @@ -71,15 +74,16 @@ func CreateAccessToken(ctx *context.APIContext, form api.CreateAccessTokenOption // responses: // "200": // "$ref": "#/responses/AccessToken" + t := &models.AccessToken{ UID: ctx.User.ID, Name: form.Name, } if err := models.NewAccessToken(t); err != nil { - ctx.Error(500, "NewAccessToken", err) + ctx.Error(http.StatusInternalServerError, "NewAccessToken", err) return } - ctx.JSON(201, &api.AccessToken{ + ctx.JSON(http.StatusCreated, &api.AccessToken{ Name: t.Name, Token: t.Token, ID: t.ID, @@ -109,15 +113,16 @@ func DeleteAccessToken(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + tokenID := ctx.ParamsInt64(":id") if err := models.DeleteAccessTokenByID(tokenID, ctx.User.ID); err != nil { if models.IsErrAccessTokenNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "DeleteAccessTokenByID", err) + ctx.Error(http.StatusInternalServerError, "DeleteAccessTokenByID", err) } return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/user/email.go b/routers/api/v1/user/email.go index 8c0eb889ed124..07fcde625e735 100644 --- a/routers/api/v1/user/email.go +++ b/routers/api/v1/user/email.go @@ -5,6 +5,8 @@ package user import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" @@ -23,16 +25,17 @@ func ListEmails(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/EmailList" + emails, err := models.GetEmailAddresses(ctx.User.ID) if err != nil { - ctx.Error(500, "GetEmailAddresses", err) + ctx.Error(http.StatusInternalServerError, "GetEmailAddresses", err) return } apiEmails := make([]*api.Email, len(emails)) for i := range emails { apiEmails[i] = convert.ToEmail(emails[i]) } - ctx.JSON(200, &apiEmails) + ctx.JSON(http.StatusOK, &apiEmails) } // AddEmail add an email address @@ -55,8 +58,11 @@ func AddEmail(ctx *context.APIContext, form api.CreateEmailOption) { // responses: // '201': // "$ref": "#/responses/EmailList" + // "422": + // "$ref": "#/responses/validationError" + if len(form.Emails) == 0 { - ctx.Status(422) + ctx.Error(http.StatusUnprocessableEntity, "", "Email list empty") return } @@ -71,9 +77,9 @@ func AddEmail(ctx *context.APIContext, form api.CreateEmailOption) { if err := models.AddEmailAddresses(emails); err != nil { if models.IsErrEmailAlreadyUsed(err) { - ctx.Error(422, "", "Email address has been used: "+err.(models.ErrEmailAlreadyUsed).Email) + ctx.Error(http.StatusUnprocessableEntity, "", "Email address has been used: "+err.(models.ErrEmailAlreadyUsed).Email) } else { - ctx.Error(500, "AddEmailAddresses", err) + ctx.Error(http.StatusInternalServerError, "AddEmailAddresses", err) } return } @@ -82,7 +88,7 @@ func AddEmail(ctx *context.APIContext, form api.CreateEmailOption) { for i := range emails { apiEmails[i] = convert.ToEmail(emails[i]) } - ctx.JSON(201, &apiEmails) + ctx.JSON(http.StatusCreated, &apiEmails) } // DeleteEmail delete email @@ -100,8 +106,9 @@ func DeleteEmail(ctx *context.APIContext, form api.DeleteEmailOption) { // responses: // "204": // "$ref": "#/responses/empty" + if len(form.Emails) == 0 { - ctx.Status(204) + ctx.Status(http.StatusNoContent) return } @@ -114,8 +121,8 @@ func DeleteEmail(ctx *context.APIContext, form api.DeleteEmailOption) { } if err := models.DeleteEmailAddresses(emails); err != nil { - ctx.Error(500, "DeleteEmailAddresses", err) + ctx.Error(http.StatusInternalServerError, "DeleteEmailAddresses", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/user/follower.go b/routers/api/v1/user/follower.go index ec512b9806e93..bd680702651b5 100644 --- a/routers/api/v1/user/follower.go +++ b/routers/api/v1/user/follower.go @@ -5,6 +5,8 @@ package user import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" @@ -16,13 +18,13 @@ func responseAPIUsers(ctx *context.APIContext, users []*models.User) { for i := range users { apiUsers[i] = convert.ToUser(users[i], ctx.IsSigned, ctx.User != nil && ctx.User.IsAdmin) } - ctx.JSON(200, &apiUsers) + ctx.JSON(http.StatusOK, &apiUsers) } func listUserFollowers(ctx *context.APIContext, u *models.User) { users, err := u.GetFollowers(ctx.QueryInt("page")) if err != nil { - ctx.Error(500, "GetUserFollowers", err) + ctx.Error(http.StatusInternalServerError, "GetUserFollowers", err) return } responseAPIUsers(ctx, users) @@ -38,6 +40,7 @@ func ListMyFollowers(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + listUserFollowers(ctx, ctx.User) } @@ -57,6 +60,7 @@ func ListFollowers(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + u := GetUserByParams(ctx) if ctx.Written() { return @@ -67,7 +71,7 @@ func ListFollowers(ctx *context.APIContext) { func listUserFollowing(ctx *context.APIContext, u *models.User) { users, err := u.GetFollowing(ctx.QueryInt("page")) if err != nil { - ctx.Error(500, "GetFollowing", err) + ctx.Error(http.StatusInternalServerError, "GetFollowing", err) return } responseAPIUsers(ctx, users) @@ -83,6 +87,7 @@ func ListMyFollowing(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + listUserFollowing(ctx, ctx.User) } @@ -102,6 +107,7 @@ func ListFollowing(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/UserList" + u := GetUserByParams(ctx) if ctx.Written() { return @@ -111,7 +117,7 @@ func ListFollowing(ctx *context.APIContext) { func checkUserFollowing(ctx *context.APIContext, u *models.User, followID int64) { if u.IsFollowing(followID) { - ctx.Status(204) + ctx.Status(http.StatusNoContent) } else { ctx.NotFound() } @@ -133,6 +139,7 @@ func CheckMyFollowing(ctx *context.APIContext) { // "$ref": "#/responses/empty" // "404": // "$ref": "#/responses/notFound" + target := GetUserByParams(ctx) if ctx.Written() { return @@ -161,6 +168,7 @@ func CheckFollowing(ctx *context.APIContext) { // "$ref": "#/responses/empty" // "404": // "$ref": "#/responses/notFound" + u := GetUserByParams(ctx) if ctx.Written() { return @@ -186,15 +194,16 @@ func Follow(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + target := GetUserByParams(ctx) if ctx.Written() { return } if err := models.FollowUser(ctx.User.ID, target.ID); err != nil { - ctx.Error(500, "FollowUser", err) + ctx.Error(http.StatusInternalServerError, "FollowUser", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // Unfollow unfollow a user @@ -211,13 +220,14 @@ func Unfollow(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + target := GetUserByParams(ctx) if ctx.Written() { return } if err := models.UnfollowUser(ctx.User.ID, target.ID); err != nil { - ctx.Error(500, "UnfollowUser", err) + ctx.Error(http.StatusInternalServerError, "UnfollowUser", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/user/gpg_key.go b/routers/api/v1/user/gpg_key.go index 82113caf0cbc6..b6133ca7be453 100644 --- a/routers/api/v1/user/gpg_key.go +++ b/routers/api/v1/user/gpg_key.go @@ -5,6 +5,8 @@ package user import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" @@ -14,7 +16,7 @@ import ( func listGPGKeys(ctx *context.APIContext, uid int64) { keys, err := models.ListGPGKeys(uid) if err != nil { - ctx.Error(500, "ListGPGKeys", err) + ctx.Error(http.StatusInternalServerError, "ListGPGKeys", err) return } @@ -23,7 +25,7 @@ func listGPGKeys(ctx *context.APIContext, uid int64) { apiKeys[i] = convert.ToGPGKey(keys[i]) } - ctx.JSON(200, &apiKeys) + ctx.JSON(http.StatusOK, &apiKeys) } //ListGPGKeys get the GPG key list of a user @@ -42,6 +44,7 @@ func ListGPGKeys(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/GPGKeyList" + user := GetUserByParams(ctx) if ctx.Written() { return @@ -59,6 +62,7 @@ func ListMyGPGKeys(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/GPGKeyList" + listGPGKeys(ctx, ctx.User.ID) } @@ -81,16 +85,17 @@ func GetGPGKey(ctx *context.APIContext) { // "$ref": "#/responses/GPGKey" // "404": // "$ref": "#/responses/notFound" + key, err := models.GetGPGKeyByID(ctx.ParamsInt64(":id")) if err != nil { if models.IsErrGPGKeyNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetGPGKeyByID", err) + ctx.Error(http.StatusInternalServerError, "GetGPGKeyByID", err) } return } - ctx.JSON(200, convert.ToGPGKey(key)) + ctx.JSON(http.StatusOK, convert.ToGPGKey(key)) } // CreateUserGPGKey creates new GPG key to given user by ID. @@ -100,7 +105,7 @@ func CreateUserGPGKey(ctx *context.APIContext, form api.CreateGPGKeyOption, uid HandleAddGPGKeyError(ctx, err) return } - ctx.JSON(201, convert.ToGPGKey(key)) + ctx.JSON(http.StatusCreated, convert.ToGPGKey(key)) } // swagger:parameters userCurrentPostGPGKey @@ -123,6 +128,7 @@ func CreateGPGKey(ctx *context.APIContext, form api.CreateGPGKeyOption) { // "$ref": "#/responses/GPGKey" // "422": // "$ref": "#/responses/validationError" + CreateUserGPGKey(ctx, form, ctx.User.ID) } @@ -145,26 +151,27 @@ func DeleteGPGKey(ctx *context.APIContext) { // "$ref": "#/responses/empty" // "403": // "$ref": "#/responses/forbidden" + if err := models.DeleteGPGKey(ctx.User, ctx.ParamsInt64(":id")); err != nil { if models.IsErrGPGKeyAccessDenied(err) { - ctx.Error(403, "", "You do not have access to this key") + ctx.Error(http.StatusForbidden, "", "You do not have access to this key") } else { - ctx.Error(500, "DeleteGPGKey", err) + ctx.Error(http.StatusInternalServerError, "DeleteGPGKey", err) } return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // HandleAddGPGKeyError handle add GPGKey error func HandleAddGPGKeyError(ctx *context.APIContext, err error) { switch { case models.IsErrGPGKeyAccessDenied(err): - ctx.Error(422, "", "You do not have access to this GPG key") + ctx.Error(http.StatusUnprocessableEntity, "", "You do not have access to this GPG key") case models.IsErrGPGKeyIDAlreadyUsed(err): - ctx.Error(422, "", "A key with the same id already exists") + ctx.Error(http.StatusUnprocessableEntity, "", "A key with the same id already exists") default: - ctx.Error(500, "AddGPGKey", err) + ctx.Error(http.StatusInternalServerError, "AddGPGKey", err) } } diff --git a/routers/api/v1/user/key.go b/routers/api/v1/user/key.go index a812edfcc7a48..7cf6fa383d86b 100644 --- a/routers/api/v1/user/key.go +++ b/routers/api/v1/user/key.go @@ -5,6 +5,8 @@ package user import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/convert" @@ -43,7 +45,7 @@ func GetUserByParamsName(ctx *context.APIContext, name string) *models.User { if models.IsErrUserNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetUserByName", err) + ctx.Error(http.StatusInternalServerError, "GetUserByName", err) } return nil } @@ -81,7 +83,7 @@ func listPublicKeys(ctx *context.APIContext, user *models.User) { } if err != nil { - ctx.Error(500, "ListPublicKeys", err) + ctx.Error(http.StatusInternalServerError, "ListPublicKeys", err) return } @@ -94,7 +96,7 @@ func listPublicKeys(ctx *context.APIContext, user *models.User) { } } - ctx.JSON(200, &apiKeys) + ctx.JSON(http.StatusOK, &apiKeys) } // ListMyPublicKeys list all of the authenticated user's public keys @@ -112,6 +114,7 @@ func ListMyPublicKeys(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/PublicKeyList" + listPublicKeys(ctx, ctx.User) } @@ -135,6 +138,7 @@ func ListPublicKeys(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/PublicKeyList" + user := GetUserByParams(ctx) if ctx.Written() { return @@ -161,12 +165,13 @@ func GetPublicKey(ctx *context.APIContext) { // "$ref": "#/responses/PublicKey" // "404": // "$ref": "#/responses/notFound" + key, err := models.GetPublicKeyByID(ctx.ParamsInt64(":id")) if err != nil { if models.IsErrKeyNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetPublicKeyByID", err) + ctx.Error(http.StatusInternalServerError, "GetPublicKeyByID", err) } return } @@ -176,7 +181,7 @@ func GetPublicKey(ctx *context.APIContext) { if ctx.User.IsAdmin || ctx.User.ID == key.OwnerID { apiKey, _ = appendPrivateInformation(apiKey, key, ctx.User) } - ctx.JSON(200, apiKey) + ctx.JSON(http.StatusOK, apiKey) } // CreateUserPublicKey creates new public key to given user by ID. @@ -197,7 +202,7 @@ func CreateUserPublicKey(ctx *context.APIContext, form api.CreateKeyOption, uid if ctx.User.IsAdmin || ctx.User.ID == key.OwnerID { apiKey, _ = appendPrivateInformation(apiKey, key, ctx.User) } - ctx.JSON(201, apiKey) + ctx.JSON(http.StatusCreated, apiKey) } // CreatePublicKey create one public key for me @@ -219,6 +224,7 @@ func CreatePublicKey(ctx *context.APIContext, form api.CreateKeyOption) { // "$ref": "#/responses/PublicKey" // "422": // "$ref": "#/responses/validationError" + CreateUserPublicKey(ctx, form, ctx.User.ID) } @@ -243,16 +249,17 @@ func DeletePublicKey(ctx *context.APIContext) { // "$ref": "#/responses/forbidden" // "404": // "$ref": "#/responses/notFound" + if err := models.DeletePublicKey(ctx.User, ctx.ParamsInt64(":id")); err != nil { if models.IsErrKeyNotExist(err) { ctx.NotFound() } else if models.IsErrKeyAccessDenied(err) { - ctx.Error(403, "", "You do not have access to this key") + ctx.Error(http.StatusForbidden, "", "You do not have access to this key") } else { - ctx.Error(500, "DeletePublicKey", err) + ctx.Error(http.StatusInternalServerError, "DeletePublicKey", err) } return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/user/repo.go b/routers/api/v1/user/repo.go index 99839b020aa99..90518f95e58c9 100644 --- a/routers/api/v1/user/repo.go +++ b/routers/api/v1/user/repo.go @@ -5,6 +5,8 @@ package user import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" api "code.gitea.io/gitea/modules/structs" @@ -14,7 +16,7 @@ import ( func listUserRepos(ctx *context.APIContext, u *models.User, private bool) { repos, err := models.GetUserRepositories(u.ID, private, 1, u.NumRepos, "") if err != nil { - ctx.Error(500, "GetUserRepositories", err) + ctx.Error(http.StatusInternalServerError, "GetUserRepositories", err) return } @@ -22,14 +24,14 @@ func listUserRepos(ctx *context.APIContext, u *models.User, private bool) { for i := range repos { access, err := models.AccessLevel(ctx.User, repos[i]) if err != nil { - ctx.Error(500, "AccessLevel", err) + ctx.Error(http.StatusInternalServerError, "AccessLevel", err) return } if ctx.IsSigned && ctx.User.IsAdmin || access >= models.AccessModeRead { apiRepos = append(apiRepos, repos[i].APIFormat(access)) } } - ctx.JSON(200, &apiRepos) + ctx.JSON(http.StatusOK, &apiRepos) } // ListUserRepos - list the repos owned by the given user. @@ -48,6 +50,7 @@ func ListUserRepos(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/RepositoryList" + user := GetUserByParams(ctx) if ctx.Written() { return @@ -66,14 +69,15 @@ func ListMyRepos(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/RepositoryList" + ownRepos, err := models.GetUserRepositories(ctx.User.ID, true, 1, ctx.User.NumRepos, "") if err != nil { - ctx.Error(500, "GetUserRepositories", err) + ctx.Error(http.StatusInternalServerError, "GetUserRepositories", err) return } accessibleReposMap, err := ctx.User.GetRepositoryAccesses() if err != nil { - ctx.Error(500, "GetRepositoryAccesses", err) + ctx.Error(http.StatusInternalServerError, "GetRepositoryAccesses", err) return } @@ -86,7 +90,7 @@ func ListMyRepos(ctx *context.APIContext) { apiRepos[i] = repo.APIFormat(access) i++ } - ctx.JSON(200, &apiRepos) + ctx.JSON(http.StatusOK, &apiRepos) } // ListOrgRepos - list the repositories of an organization. @@ -105,5 +109,6 @@ func ListOrgRepos(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/RepositoryList" + listUserRepos(ctx, ctx.Org.Organization, ctx.IsSigned) } diff --git a/routers/api/v1/user/star.go b/routers/api/v1/user/star.go index 744e0bf7d5fd9..e5d3a8f0a01ff 100644 --- a/routers/api/v1/user/star.go +++ b/routers/api/v1/user/star.go @@ -5,6 +5,8 @@ package user import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" api "code.gitea.io/gitea/modules/structs" @@ -45,13 +47,14 @@ func GetStarredRepos(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/RepositoryList" + user := GetUserByParams(ctx) private := user.ID == ctx.User.ID repos, err := getStarredRepos(user, private) if err != nil { - ctx.Error(500, "getStarredRepos", err) + ctx.Error(http.StatusInternalServerError, "getStarredRepos", err) } - ctx.JSON(200, &repos) + ctx.JSON(http.StatusOK, &repos) } // GetMyStarredRepos returns the repos that the authenticated user has starred @@ -64,11 +67,12 @@ func GetMyStarredRepos(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/RepositoryList" + repos, err := getStarredRepos(ctx.User, true) if err != nil { - ctx.Error(500, "getStarredRepos", err) + ctx.Error(http.StatusInternalServerError, "getStarredRepos", err) } - ctx.JSON(200, &repos) + ctx.JSON(http.StatusOK, &repos) } // IsStarring returns whether the authenticated is starring the repo @@ -92,8 +96,9 @@ func IsStarring(ctx *context.APIContext) { // "$ref": "#/responses/empty" // "404": // "$ref": "#/responses/notFound" + if models.IsStaring(ctx.User.ID, ctx.Repo.Repository.ID) { - ctx.Status(204) + ctx.Status(http.StatusNoContent) } else { ctx.NotFound() } @@ -118,12 +123,13 @@ func Star(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + err := models.StarRepo(ctx.User.ID, ctx.Repo.Repository.ID, true) if err != nil { - ctx.Error(500, "StarRepo", err) + ctx.Error(http.StatusInternalServerError, "StarRepo", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // Unstar the repo specified in the APIContext, as the authenticated user @@ -145,10 +151,11 @@ func Unstar(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + err := models.StarRepo(ctx.User.ID, ctx.Repo.Repository.ID, false) if err != nil { - ctx.Error(500, "StarRepo", err) + ctx.Error(http.StatusInternalServerError, "StarRepo", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } diff --git a/routers/api/v1/user/user.go b/routers/api/v1/user/user.go index 6f3fc4d32bbbc..3f17a6f91b3ed 100644 --- a/routers/api/v1/user/user.go +++ b/routers/api/v1/user/user.go @@ -49,6 +49,7 @@ func Search(ctx *context.APIContext) { // type: array // items: // "$ref": "#/definitions/User" + opts := &models.SearchUserOptions{ Keyword: strings.Trim(ctx.Query("q"), " "), UID: com.StrTo(ctx.Query("uid")).MustInt64(), @@ -58,7 +59,7 @@ func Search(ctx *context.APIContext) { users, _, err := models.SearchUsers(opts) if err != nil { - ctx.JSON(500, map[string]interface{}{ + ctx.JSON(http.StatusInternalServerError, map[string]interface{}{ "ok": false, "error": err.Error(), }) @@ -70,7 +71,7 @@ func Search(ctx *context.APIContext) { results[i] = convert.ToUser(users[i], ctx.IsSigned, ctx.User != nil && ctx.User.IsAdmin) } - ctx.JSON(200, map[string]interface{}{ + ctx.JSON(http.StatusOK, map[string]interface{}{ "ok": true, "data": results, }) @@ -94,17 +95,18 @@ func GetInfo(ctx *context.APIContext) { // "$ref": "#/responses/User" // "404": // "$ref": "#/responses/notFound" + u, err := models.GetUserByName(ctx.Params(":username")) if err != nil { if models.IsErrUserNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetUserByName", err) + ctx.Error(http.StatusInternalServerError, "GetUserByName", err) } return } - ctx.JSON(200, convert.ToUser(u, ctx.IsSigned, ctx.User != nil && (ctx.User.ID == u.ID || ctx.User.IsAdmin))) + ctx.JSON(http.StatusOK, convert.ToUser(u, ctx.IsSigned, ctx.User != nil && (ctx.User.ID == u.ID || ctx.User.IsAdmin))) } // GetAuthenticatedUser get current user's information @@ -117,7 +119,8 @@ func GetAuthenticatedUser(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/User" - ctx.JSON(200, convert.ToUser(ctx.User, ctx.IsSigned, ctx.User != nil)) + + ctx.JSON(http.StatusOK, convert.ToUser(ctx.User, ctx.IsSigned, ctx.User != nil)) } // GetUserHeatmapData is the handler to get a users heatmap @@ -155,5 +158,5 @@ func GetUserHeatmapData(ctx *context.APIContext) { ctx.Error(http.StatusInternalServerError, "GetUserHeatmapDataByUser", err) return } - ctx.JSON(200, heatmap) + ctx.JSON(http.StatusOK, heatmap) } diff --git a/routers/api/v1/user/watch.go b/routers/api/v1/user/watch.go index 87739b15fbcaf..ec8543dcf0c43 100644 --- a/routers/api/v1/user/watch.go +++ b/routers/api/v1/user/watch.go @@ -5,6 +5,8 @@ package user import ( + "net/http" + "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/setting" @@ -46,13 +48,14 @@ func GetWatchedRepos(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/RepositoryList" + user := GetUserByParams(ctx) private := user.ID == ctx.User.ID repos, err := getWatchedRepos(user, private) if err != nil { - ctx.Error(500, "getWatchedRepos", err) + ctx.Error(http.StatusInternalServerError, "getWatchedRepos", err) } - ctx.JSON(200, &repos) + ctx.JSON(http.StatusOK, &repos) } // GetMyWatchedRepos returns the repos that the authenticated user is watching @@ -65,11 +68,12 @@ func GetMyWatchedRepos(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/RepositoryList" + repos, err := getWatchedRepos(ctx.User, true) if err != nil { - ctx.Error(500, "getWatchedRepos", err) + ctx.Error(http.StatusInternalServerError, "getWatchedRepos", err) } - ctx.JSON(200, &repos) + ctx.JSON(http.StatusOK, &repos) } // IsWatching returns whether the authenticated user is watching the repo @@ -92,8 +96,9 @@ func IsWatching(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/WatchInfo" + if models.IsWatching(ctx.User.ID, ctx.Repo.Repository.ID) { - ctx.JSON(200, api.WatchInfo{ + ctx.JSON(http.StatusOK, api.WatchInfo{ Subscribed: true, Ignored: false, Reason: nil, @@ -125,12 +130,13 @@ func Watch(ctx *context.APIContext) { // responses: // "200": // "$ref": "#/responses/WatchInfo" + err := models.WatchRepo(ctx.User.ID, ctx.Repo.Repository.ID, true) if err != nil { - ctx.Error(500, "WatchRepo", err) + ctx.Error(http.StatusInternalServerError, "WatchRepo", err) return } - ctx.JSON(200, api.WatchInfo{ + ctx.JSON(http.StatusOK, api.WatchInfo{ Subscribed: true, Ignored: false, Reason: nil, @@ -160,12 +166,13 @@ func Unwatch(ctx *context.APIContext) { // responses: // "204": // "$ref": "#/responses/empty" + err := models.WatchRepo(ctx.User.ID, ctx.Repo.Repository.ID, false) if err != nil { - ctx.Error(500, "UnwatchRepo", err) + ctx.Error(http.StatusInternalServerError, "UnwatchRepo", err) return } - ctx.Status(204) + ctx.Status(http.StatusNoContent) } // subscriptionURL returns the URL of the subscription API endpoint of a repo diff --git a/routers/api/v1/utils/hook.go b/routers/api/v1/utils/hook.go index f88b15200389a..9a6733f9dc143 100644 --- a/routers/api/v1/utils/hook.go +++ b/routers/api/v1/utils/hook.go @@ -27,7 +27,7 @@ func GetOrgHook(ctx *context.APIContext, orgID, hookID int64) (*models.Webhook, if models.IsErrWebhookNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetWebhookByOrgID", err) + ctx.Error(http.StatusInternalServerError, "GetWebhookByOrgID", err) } return nil, err } @@ -42,7 +42,7 @@ func GetRepoHook(ctx *context.APIContext, repoID, hookID int64) (*models.Webhook if models.IsErrWebhookNotExist(err) { ctx.NotFound() } else { - ctx.Error(500, "GetWebhookByID", err) + ctx.Error(http.StatusInternalServerError, "GetWebhookByID", err) } return nil, err } @@ -53,17 +53,17 @@ func GetRepoHook(ctx *context.APIContext, repoID, hookID int64) (*models.Webhook // write the appropriate error to `ctx`. Return whether the form is valid func CheckCreateHookOption(ctx *context.APIContext, form *api.CreateHookOption) bool { if !models.IsValidHookTaskType(form.Type) { - ctx.Error(422, "", "Invalid hook type") + ctx.Error(http.StatusUnprocessableEntity, "", "Invalid hook type") return false } for _, name := range []string{"url", "content_type"} { if _, ok := form.Config[name]; !ok { - ctx.Error(422, "", "Missing config option: "+name) + ctx.Error(http.StatusUnprocessableEntity, "", "Missing config option: "+name) return false } } if !models.IsValidHookContentType(form.Config["content_type"]) { - ctx.Error(422, "", "Invalid content type") + ctx.Error(http.StatusUnprocessableEntity, "", "Invalid content type") return false } return true @@ -121,12 +121,12 @@ func addHook(ctx *context.APIContext, form *api.CreateHookOption, orgID, repoID if w.HookTaskType == models.SLACK { channel, ok := form.Config["channel"] if !ok { - ctx.Error(422, "", "Missing config option: channel") + ctx.Error(http.StatusUnprocessableEntity, "", "Missing config option: channel") return nil, false } if !utils.IsValidSlackChannel(channel) { - ctx.Error(400, "", "Invalid slack channel name") + ctx.Error(http.StatusBadRequest, "", "Invalid slack channel name") return nil, false } @@ -137,17 +137,17 @@ func addHook(ctx *context.APIContext, form *api.CreateHookOption, orgID, repoID Color: form.Config["color"], }) if err != nil { - ctx.Error(500, "slack: JSON marshal failed", err) + ctx.Error(http.StatusInternalServerError, "slack: JSON marshal failed", err) return nil, false } w.Meta = string(meta) } if err := w.UpdateEvent(); err != nil { - ctx.Error(500, "UpdateEvent", err) + ctx.Error(http.StatusInternalServerError, "UpdateEvent", err) return nil, false } else if err := models.CreateWebhook(w); err != nil { - ctx.Error(500, "CreateWebhook", err) + ctx.Error(http.StatusInternalServerError, "CreateWebhook", err) return nil, false } return w, true @@ -167,7 +167,7 @@ func EditOrgHook(ctx *context.APIContext, form *api.EditHookOption, hookID int64 if err != nil { return } - ctx.JSON(200, convert.ToHook(org.HomeLink(), updated)) + ctx.JSON(http.StatusOK, convert.ToHook(org.HomeLink(), updated)) } // EditRepoHook edit webhook `w` according to `form`. Writes to `ctx` accordingly @@ -184,7 +184,7 @@ func EditRepoHook(ctx *context.APIContext, form *api.EditHookOption, hookID int6 if err != nil { return } - ctx.JSON(200, convert.ToHook(repo.RepoLink, updated)) + ctx.JSON(http.StatusOK, convert.ToHook(repo.RepoLink, updated)) } // editHook edit the webhook `w` according to `form`. If an error occurs, write @@ -196,7 +196,7 @@ func editHook(ctx *context.APIContext, form *api.EditHookOption, w *models.Webho } if ct, ok := form.Config["content_type"]; ok { if !models.IsValidHookContentType(ct) { - ctx.Error(422, "", "Invalid content type") + ctx.Error(http.StatusUnprocessableEntity, "", "Invalid content type") return false } w.ContentType = models.ToHookContentType(ct) @@ -211,7 +211,7 @@ func editHook(ctx *context.APIContext, form *api.EditHookOption, w *models.Webho Color: form.Config["color"], }) if err != nil { - ctx.Error(500, "slack: JSON marshal failed", err) + ctx.Error(http.StatusInternalServerError, "slack: JSON marshal failed", err) return false } w.Meta = string(meta) @@ -241,7 +241,7 @@ func editHook(ctx *context.APIContext, form *api.EditHookOption, w *models.Webho w.BranchFilter = form.BranchFilter if err := w.UpdateEvent(); err != nil { - ctx.Error(500, "UpdateEvent", err) + ctx.Error(http.StatusInternalServerError, "UpdateEvent", err) return false } @@ -250,7 +250,7 @@ func editHook(ctx *context.APIContext, form *api.EditHookOption, w *models.Webho } if err := models.UpdateWebhook(w); err != nil { - ctx.Error(500, "UpdateWebhook", err) + ctx.Error(http.StatusInternalServerError, "UpdateWebhook", err) return false } return true diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index f1789535bafae..dc9dd2395fe8c 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -101,6 +101,9 @@ "201": { "$ref": "#/responses/User" }, + "400": { + "$ref": "#/responses/error" + }, "403": { "$ref": "#/responses/forbidden" }, @@ -344,6 +347,12 @@ "403": { "$ref": "#/responses/forbidden" }, + "404": { + "$ref": "#/responses/notFound" + }, + "409": { + "$ref": "#/responses/error" + }, "422": { "$ref": "#/responses/validationError" } @@ -803,6 +812,9 @@ "204": { "description": "user is a member" }, + "302": { + "description": "redirection to /orgs/{org}/public_members/{username}" + }, "404": { "description": "user is not a member" } @@ -926,6 +938,9 @@ "responses": { "204": { "description": "membership publicized" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -957,6 +972,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -1043,6 +1061,9 @@ "responses": { "201": { "$ref": "#/responses/Team" + }, + "422": { + "$ref": "#/responses/validationError" } } } @@ -1186,6 +1207,12 @@ "responses": { "201": { "$ref": "#/responses/Repository" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "422": { + "$ref": "#/responses/validationError" } } } @@ -1447,6 +1474,9 @@ "responses": { "200": { "description": "success" + }, + "404": { + "$ref": "#/responses/notFound" } } } @@ -1595,7 +1625,10 @@ "$ref": "#/responses/empty" }, "404": { - "$ref": "#/responses/empty" + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" } } }, @@ -1641,6 +1674,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "422": { + "$ref": "#/responses/validationError" } } }, @@ -1679,6 +1715,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "422": { + "$ref": "#/responses/validationError" } } } @@ -1776,6 +1815,9 @@ "responses": { "200": { "$ref": "#/responses/Status" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -2048,6 +2090,9 @@ "responses": { "200": { "description": "success" + }, + "404": { + "$ref": "#/responses/notFound" } } } @@ -2119,6 +2164,12 @@ "responses": { "202": { "$ref": "#/responses/Repository" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "422": { + "$ref": "#/responses/validationError" } } } @@ -2159,6 +2210,9 @@ "responses": { "200": { "$ref": "#/responses/GitBlobResponse" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -2321,6 +2375,9 @@ "responses": { "200": { "$ref": "#/responses/AnnotatedTag" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -2379,6 +2436,9 @@ "responses": { "200": { "$ref": "#/responses/GitTreeResponse" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -2659,6 +2719,9 @@ "responses": { "200": { "$ref": "#/responses/Hook" + }, + "404": { + "$ref": "#/responses/notFound" } } }, @@ -2886,6 +2949,15 @@ "responses": { "201": { "$ref": "#/responses/Issue" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "412": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" } } } @@ -2963,6 +3035,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -3056,6 +3131,9 @@ "responses": { "200": { "$ref": "#/responses/ReactionResponseList" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -3105,6 +3183,9 @@ "responses": { "201": { "$ref": "#/responses/ReactionResponse" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -3154,6 +3235,9 @@ "responses": { "200": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -3195,6 +3279,9 @@ "responses": { "200": { "$ref": "#/responses/TrackedTimeList" + }, + "404": { + "$ref": "#/responses/notFound" } } }, @@ -3249,7 +3336,7 @@ "$ref": "#/responses/error" }, "403": { - "$ref": "#/responses/error" + "$ref": "#/responses/forbidden" } } } @@ -3291,6 +3378,9 @@ "responses": { "200": { "$ref": "#/responses/Issue" + }, + "404": { + "$ref": "#/responses/notFound" } } }, @@ -3340,6 +3430,15 @@ "responses": { "201": { "$ref": "#/responses/Issue" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "412": { + "$ref": "#/responses/error" } } } @@ -3436,6 +3535,9 @@ "responses": { "201": { "$ref": "#/responses/Comment" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -3482,6 +3584,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -3539,6 +3644,12 @@ "responses": { "200": { "$ref": "#/responses/Comment" + }, + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -3592,10 +3703,10 @@ "$ref": "#/responses/IssueDeadline" }, "403": { - "description": "Not repo writer" + "$ref": "#/responses/forbidden" }, "404": { - "description": "Issue not found" + "$ref": "#/responses/notFound" } } } @@ -3689,6 +3800,9 @@ "responses": { "200": { "$ref": "#/responses/LabelList" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -3738,6 +3852,9 @@ "responses": { "200": { "$ref": "#/responses/LabelList" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -3777,6 +3894,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -3826,6 +3946,12 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "422": { + "$ref": "#/responses/validationError" } } } @@ -3870,6 +3996,9 @@ "responses": { "200": { "$ref": "#/responses/ReactionResponseList" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -3919,6 +4048,9 @@ "responses": { "201": { "$ref": "#/responses/ReactionResponse" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -3968,6 +4100,9 @@ "responses": { "200": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -4017,7 +4152,7 @@ "description": "Not repo writer, user does not have rights to toggle stopwatch" }, "404": { - "description": "Issue not found" + "$ref": "#/responses/notFound" }, "409": { "description": "Cannot cancel a non existent stopwatch" @@ -4070,7 +4205,7 @@ "description": "Not repo writer, user does not have rights to toggle stopwatch" }, "404": { - "description": "Issue not found" + "$ref": "#/responses/notFound" }, "409": { "description": "Cannot start a stopwatch again if it already exists" @@ -4123,7 +4258,7 @@ "description": "Not repo writer, user does not have rights to toggle stopwatch" }, "404": { - "description": "Issue not found" + "$ref": "#/responses/notFound" }, "409": { "description": "Cannot stop a non existent stopwatch" @@ -4173,7 +4308,7 @@ "$ref": "#/responses/UserList" }, "404": { - "description": "Issue not found" + "$ref": "#/responses/notFound" } } } @@ -4230,7 +4365,7 @@ "description": "User can only subscribe itself if he is no admin" }, "404": { - "description": "Issue not found" + "$ref": "#/responses/notFound" } } }, @@ -4285,7 +4420,7 @@ "description": "User can only subscribe itself if he is no admin" }, "404": { - "description": "Issue not found" + "$ref": "#/responses/notFound" } } } @@ -4372,6 +4507,9 @@ "responses": { "201": { "$ref": "#/responses/DeployKey" + }, + "422": { + "$ref": "#/responses/validationError" } } } @@ -4449,6 +4587,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -4888,6 +5029,9 @@ "responses": { "200": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -5011,6 +5155,12 @@ "responses": { "201": { "$ref": "#/responses/PullRequest" + }, + "409": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" } } } @@ -5101,6 +5251,15 @@ "responses": { "201": { "$ref": "#/responses/PullRequest" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "412": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" } } } @@ -5194,6 +5353,9 @@ }, "405": { "$ref": "#/responses/empty" + }, + "409": { + "$ref": "#/responses/error" } } } @@ -5234,6 +5396,9 @@ "responses": { "200": { "description": "success" + }, + "404": { + "$ref": "#/responses/notFound" } } } @@ -5320,6 +5485,9 @@ "responses": { "201": { "$ref": "#/responses/Release" + }, + "409": { + "$ref": "#/responses/error" } } } @@ -5542,6 +5710,9 @@ "responses": { "201": { "$ref": "#/responses/Attachment" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -5836,6 +6007,9 @@ "responses": { "200": { "$ref": "#/responses/StatusList" + }, + "400": { + "$ref": "#/responses/error" } } }, @@ -5881,6 +6055,9 @@ "responses": { "201": { "$ref": "#/responses/Status" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -6066,6 +6243,9 @@ "responses": { "200": { "$ref": "#/responses/TrackedTimeList" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -6106,6 +6286,9 @@ "responses": { "200": { "$ref": "#/responses/TrackedTimeList" + }, + "400": { + "$ref": "#/responses/error" } } } @@ -6177,6 +6360,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "422": { + "$ref": "#/responses/invalidTopicsError" } } } @@ -6217,6 +6403,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "422": { + "$ref": "#/responses/invalidTopicsError" } } }, @@ -6255,6 +6444,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "422": { + "$ref": "#/responses/invalidTopicsError" } } } @@ -6446,6 +6638,9 @@ "responses": { "200": { "$ref": "#/responses/User" + }, + "404": { + "$ref": "#/responses/notFound" } } }, @@ -6478,6 +6673,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" } } }, @@ -6510,6 +6708,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" } } } @@ -6578,6 +6779,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } }, @@ -6618,6 +6822,9 @@ "responses": { "204": { "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -6644,6 +6851,9 @@ "responses": { "200": { "$ref": "#/responses/TopicListResponse" + }, + "403": { + "$ref": "#/responses/forbidden" } } } @@ -6702,6 +6912,9 @@ "responses": { "201": { "$ref": "#/responses/EmailList" + }, + "422": { + "$ref": "#/responses/validationError" } } }, @@ -11773,6 +11986,20 @@ } } }, + "invalidTopicsError": { + "description": "APIInvalidTopicsError is error format response to invalid topics", + "headers": { + "invalidTopics": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + }, "notFound": { "description": "APINotFound is a not found empty response" },