0
0
mirror of https://github.com/go-gitea/gitea.git synced 2025-06-04 18:56:50 +02:00
gitea/routers/api/v1/repo/star.go
Christopher Homberger aef1d49c32 Reduce paging inconsistency
* disallow bypassing configured limits in api
* allow per_page without documenting it
* allow limit for the only endpoint only allowing per_page

This is an paging inconsistency api review, please comment your opinion about the added code comments

* 	ctx.SetLinkHeader(int(totalNumOfBranches), listOptions.PageSize) missing for several api endpoints should I add them everywhere?

* do we want to accept per_page in api?
  * better compatibility with existing keda github_runner
2025-05-28 20:51:27 +02:00

67 lines
1.7 KiB
Go

// Copyright 2017 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package repo
import (
"net/http"
repo_model "code.gitea.io/gitea/models/repo"
api "code.gitea.io/gitea/modules/structs"
"code.gitea.io/gitea/routers/api/v1/utils"
"code.gitea.io/gitea/services/context"
"code.gitea.io/gitea/services/convert"
)
// ListStargazers list a repository's stargazers
func ListStargazers(ctx *context.APIContext) {
// swagger:operation GET /repos/{owner}/{repo}/stargazers repository repoListStargazers
// ---
// summary: List a repo's stargazers
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo
// type: string
// required: true
// - name: 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/UserList"
// "404":
// "$ref": "#/responses/notFound"
// "403":
// "$ref": "#/responses/forbidden"
opts := utils.GetListOptions(ctx)
// GetStargazers allows pagination bypass
opts.SetDefaultValues()
stargazers, err := repo_model.GetStargazers(ctx, ctx.Repo.Repository, opts)
if err != nil {
ctx.APIErrorInternal(err)
return
}
users := make([]*api.User, len(stargazers))
for i, stargazer := range stargazers {
users[i] = convert.ToUser(ctx, stargazer, ctx.Doer)
}
ctx.SetTotalCountHeader(int64(ctx.Repo.Repository.NumStars))
ctx.JSON(http.StatusOK, users)
}