Return 404 from Contents API when items don't exist #10323
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -362,9 +362,15 @@ func DeleteFile(ctx *context.APIContext, apiOpts api.DeleteFileOptions) { | |
| // responses: | ||
| // "200": | ||
| // "$ref": "#/responses/FileDeleteResponse" | ||
| // "400": | ||
| // "$ref": "#/responses/error" | ||
| // "403": | ||
| // "$ref": "#/responses/error" | ||
| // "404": | ||
| // "$ref": "#/responses/error" | ||
|
|
||
| if !CanWriteFiles(ctx.Repo) { | ||
| ctx.Error(http.StatusForbidden, "DeleteFile", models.ErrUserDoesNotHaveAccessToRepo{ | ||
|
There was a problem hiding this comment. I hesitate to think this should maybe kept as In case you want to keep There was a problem hiding this comment. If you have read only access it should be forbidden status, in case you don't have any access it should be not found status but not internal server error There was a problem hiding this comment. In order to get to DeleteFile you have to pass: m.Delete("", bind(api.DeleteFileOptions{}), repo.DeleteFile)
}, reqRepoWriter(models.UnitTypeCode), reqToken())
}, reqRepoReader(models.UnitTypeCode))
...
}, repoAssignment())CanWriteFiles does the following in addition: // CanWriteFiles returns true if repository is editable and user has proper access level.
func CanWriteFiles(r *context.Repository) bool {
return r.Permission.CanWrite(models.UnitTypeCode) && !r.Repository.IsMirror && !r.Repository.IsArchived
}Therefore HttpStatusForbidden or HttpBadRequest are the correct statuses not 404 nor 500. |
||
| UserID: ctx.User.ID, | ||
| RepoName: ctx.Repo.Repository.LowerName, | ||
| }) | ||
|
|
@@ -402,9 +408,23 @@ func DeleteFile(ctx *context.APIContext, apiOpts api.DeleteFileOptions) { | |
| } | ||
|
|
||
| if fileResponse, err := repofiles.DeleteRepoFile(ctx.Repo.Repository, ctx.User, opts); err != nil { | ||
| if git.IsErrBranchNotExist(err) || models.IsErrRepoFileDoesNotExist(err) || git.IsErrNotExist(err) { | ||
| ctx.Error(http.StatusNotFound, "DeleteFile", err) | ||
| return | ||
| } else if models.IsErrBranchAlreadyExists(err) || | ||
| models.IsErrFilenameInvalid(err) || | ||
| models.IsErrSHADoesNotMatch(err) || | ||
| models.IsErrCommitIDDoesNotMatch(err) || | ||
| models.IsErrSHAOrCommitIDNotProvided(err) { | ||
| ctx.Error(http.StatusBadRequest, "DeleteFile", err) | ||
| return | ||
| } else if models.IsErrUserCannotCommit(err) { | ||
| ctx.Error(http.StatusForbidden, "DeleteFile", err) | ||
| return | ||
| } | ||
| ctx.Error(http.StatusInternalServerError, "DeleteFile", err) | ||
| } else { | ||
| ctx.JSON(http.StatusOK, fileResponse) // FIXME on APIv2: return http.StatusNoContent | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -439,6 +459,8 @@ func GetContents(ctx *context.APIContext) { | |
| // responses: | ||
| // "200": | ||
| // "$ref": "#/responses/ContentsResponse" | ||
| // "404": | ||
| // "$ref": "#/responses/notFound" | ||
|
|
||
| if !CanReadFiles(ctx.Repo) { | ||
| ctx.Error(http.StatusInternalServerError, "GetContentsOrList", models.ErrUserDoesNotHaveAccessToRepo{ | ||
|
|
@@ -452,6 +474,10 @@ func GetContents(ctx *context.APIContext) { | |
| ref := ctx.QueryTrim("ref") | ||
|
|
||
| if fileList, err := repofiles.GetContentsOrList(ctx.Repo.Repository, treePath, ref); err != nil { | ||
| if git.IsErrNotExist(err) { | ||
| ctx.NotFound("GetContentsOrList", err) | ||
| return | ||
| } | ||
| ctx.Error(http.StatusInternalServerError, "GetContentsOrList", err) | ||
| } else { | ||
| ctx.JSON(http.StatusOK, fileList) | ||
|
|
@@ -484,6 +510,8 @@ func GetContentsList(ctx *context.APIContext) { | |
| // responses: | ||
| // "200": | ||
| // "$ref": "#/responses/ContentsListResponse" | ||
| // "404": | ||
| // "$ref": "#/responses/notFound" | ||
|
|
||
| // same as GetContents(), this function is here because swagger fails if path is empty in GetContents() interface | ||
| GetContents(ctx) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.