mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-05 06:02:41 +01:00
9d943bf374
* Add missing `X-Total-Count` and fix some related bugs
Adds `X-Total-Count` header to APIs that return a list but doesn't have it yet.
Fixed bugs:
* not returned after reporting error (39eb82446c/routers/api/v1/user/star.go (L70)
)
* crash with index out of bounds, API issue/issueSubscriptions
I also found various endpoints that return lists but do not apply/support pagination yet:
```
/repos/{owner}/{repo}/issues/{index}/labels
/repos/{owner}/{repo}/issues/comments/{id}/reactions
/repos/{owner}/{repo}/branch_protections
/repos/{owner}/{repo}/contents
/repos/{owner}/{repo}/hooks/git
/repos/{owner}/{repo}/issue_templates
/repos/{owner}/{repo}/releases/{id}/assets
/repos/{owner}/{repo}/reviewers
/repos/{owner}/{repo}/teams
/user/emails
/users/{username}/heatmap
```
If this is not expected, an new issue should be opened.
Closes #13043
* fmt
* Update routers/api/v1/repo/issue_subscription.go
Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
* Use FindAndCount
Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
Co-authored-by: 6543 <6543@obermui.de>
189 lines
5.1 KiB
Go
189 lines
5.1 KiB
Go
// Copyright 2016 The Gogs Authors. All rights reserved.
|
|
// Copyright 2020 The Gitea Authors.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package user
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/models/db"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/convert"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/routers/api/v1/utils"
|
|
)
|
|
|
|
// getStarredRepos returns the repos that the user with the specified userID has
|
|
// starred
|
|
func getStarredRepos(user *user_model.User, private bool, listOptions db.ListOptions) ([]*api.Repository, error) {
|
|
starredRepos, err := models.GetStarredRepos(user.ID, private, listOptions)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
repos := make([]*api.Repository, len(starredRepos))
|
|
for i, starred := range starredRepos {
|
|
access, err := models.AccessLevel(user, starred)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
repos[i] = convert.ToRepo(starred, access)
|
|
}
|
|
return repos, nil
|
|
}
|
|
|
|
// GetStarredRepos returns the repos that the given user has starred
|
|
func GetStarredRepos(ctx *context.APIContext) {
|
|
// swagger:operation GET /users/{username}/starred user userListStarred
|
|
// ---
|
|
// summary: The repos that the given user has starred
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: username
|
|
// in: path
|
|
// description: username of user
|
|
// type: string
|
|
// required: true
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results to return (1-based)
|
|
// type: integer
|
|
// - name: limit
|
|
// in: query
|
|
// description: page size of results
|
|
// type: integer
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/RepositoryList"
|
|
|
|
user := GetUserByParams(ctx)
|
|
private := user.ID == ctx.User.ID
|
|
repos, err := getStarredRepos(user, private, utils.GetListOptions(ctx))
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "getStarredRepos", err)
|
|
return
|
|
}
|
|
|
|
ctx.SetTotalCountHeader(int64(user.NumStars))
|
|
ctx.JSON(http.StatusOK, &repos)
|
|
}
|
|
|
|
// GetMyStarredRepos returns the repos that the authenticated user has starred
|
|
func GetMyStarredRepos(ctx *context.APIContext) {
|
|
// swagger:operation GET /user/starred user userCurrentListStarred
|
|
// ---
|
|
// summary: The repos that the authenticated user has starred
|
|
// parameters:
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results to return (1-based)
|
|
// type: integer
|
|
// - name: limit
|
|
// in: query
|
|
// description: page size of results
|
|
// type: integer
|
|
// produces:
|
|
// - application/json
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/RepositoryList"
|
|
|
|
repos, err := getStarredRepos(ctx.User, true, utils.GetListOptions(ctx))
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "getStarredRepos", err)
|
|
}
|
|
|
|
ctx.SetTotalCountHeader(int64(ctx.User.NumStars))
|
|
ctx.JSON(http.StatusOK, &repos)
|
|
}
|
|
|
|
// IsStarring returns whether the authenticated is starring the repo
|
|
func IsStarring(ctx *context.APIContext) {
|
|
// swagger:operation GET /user/starred/{owner}/{repo} user userCurrentCheckStarring
|
|
// ---
|
|
// summary: Whether the authenticated is starring the repo
|
|
// parameters:
|
|
// - name: owner
|
|
// in: path
|
|
// description: owner of the repo
|
|
// type: string
|
|
// required: true
|
|
// - name: repo
|
|
// in: path
|
|
// description: name of the repo
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
if repo_model.IsStaring(ctx.User.ID, ctx.Repo.Repository.ID) {
|
|
ctx.Status(http.StatusNoContent)
|
|
} else {
|
|
ctx.NotFound()
|
|
}
|
|
}
|
|
|
|
// Star the repo specified in the APIContext, as the authenticated user
|
|
func Star(ctx *context.APIContext) {
|
|
// swagger:operation PUT /user/starred/{owner}/{repo} user userCurrentPutStar
|
|
// ---
|
|
// summary: Star the given repo
|
|
// parameters:
|
|
// - name: owner
|
|
// in: path
|
|
// description: owner of the repo to star
|
|
// type: string
|
|
// required: true
|
|
// - name: repo
|
|
// in: path
|
|
// description: name of the repo to star
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
|
|
err := repo_model.StarRepo(ctx.User.ID, ctx.Repo.Repository.ID, true)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "StarRepo", err)
|
|
return
|
|
}
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|
|
|
|
// Unstar the repo specified in the APIContext, as the authenticated user
|
|
func Unstar(ctx *context.APIContext) {
|
|
// swagger:operation DELETE /user/starred/{owner}/{repo} user userCurrentDeleteStar
|
|
// ---
|
|
// summary: Unstar the given repo
|
|
// parameters:
|
|
// - name: owner
|
|
// in: path
|
|
// description: owner of the repo to unstar
|
|
// type: string
|
|
// required: true
|
|
// - name: repo
|
|
// in: path
|
|
// description: name of the repo to unstar
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
|
|
err := repo_model.StarRepo(ctx.User.ID, ctx.Repo.Repository.ID, false)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "StarRepo", err)
|
|
return
|
|
}
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|