mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-22 20:33:46 +02:00
* Update swagger documentation Add docs for missing endpoints Add documentation for request parameters Make parameter naming consistent Fix response documentation * Restore delete comments
156 lines
4.0 KiB
Go
156 lines
4.0 KiB
Go
// Copyright 2016 The Gogs Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package user
|
|
|
|
import (
|
|
api "code.gitea.io/sdk/gitea"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/modules/context"
|
|
)
|
|
|
|
// getStarredRepos returns the repos that the user with the specified userID has
|
|
// starred
|
|
func getStarredRepos(userID int64, private bool) ([]*api.Repository, error) {
|
|
starredRepos, err := models.GetStarredRepos(userID, private)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
repos := make([]*api.Repository, len(starredRepos))
|
|
for i, starred := range starredRepos {
|
|
access, err := models.AccessLevel(userID, starred)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
repos[i] = starred.APIFormat(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
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/RepositoryList"
|
|
user := GetUserByParams(ctx)
|
|
private := user.ID == ctx.User.ID
|
|
repos, err := getStarredRepos(user.ID, private)
|
|
if err != nil {
|
|
ctx.Error(500, "getStarredRepos", err)
|
|
}
|
|
ctx.JSON(200, &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
|
|
// produces:
|
|
// - application/json
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/RepositoryList"
|
|
repos, err := getStarredRepos(ctx.User.ID, true)
|
|
if err != nil {
|
|
ctx.Error(500, "getStarredRepos", err)
|
|
}
|
|
ctx.JSON(200, &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 models.IsStaring(ctx.User.ID, ctx.Repo.Repository.ID) {
|
|
ctx.Status(204)
|
|
} else {
|
|
ctx.Status(404)
|
|
}
|
|
}
|
|
|
|
// 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 := models.StarRepo(ctx.User.ID, ctx.Repo.Repository.ID, true)
|
|
if err != nil {
|
|
ctx.Error(500, "StarRepo", err)
|
|
return
|
|
}
|
|
ctx.Status(204)
|
|
}
|
|
|
|
// 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 := models.StarRepo(ctx.User.ID, ctx.Repo.Repository.ID, false)
|
|
if err != nil {
|
|
ctx.Error(500, "StarRepo", err)
|
|
return
|
|
}
|
|
ctx.Status(204)
|
|
}
|