mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-11-03 21:16:26 +01:00 
			
		
		
		
	* 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 👍
* use ctx.InternalServerError
* Revert "use numbers and not http.Status___ enum"
This reverts commit b1ff386e2418ed6a7f183e756b13277d701278ef.
* use http.Status* enum everywhere
		
	
			
		
			
				
	
	
		
			121 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			121 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2018 The Gitea 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 repo
 | 
						|
 | 
						|
import (
 | 
						|
	"net/http"
 | 
						|
 | 
						|
	"code.gitea.io/gitea/modules/context"
 | 
						|
	"code.gitea.io/gitea/modules/git"
 | 
						|
	api "code.gitea.io/gitea/modules/structs"
 | 
						|
)
 | 
						|
 | 
						|
// GetGitAllRefs get ref or an list all the refs of a repository
 | 
						|
func GetGitAllRefs(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/git/refs repository repoListAllGitRefs
 | 
						|
	// ---
 | 
						|
	// summary: Get specified ref or filtered repository's refs
 | 
						|
	// 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
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/Reference"
 | 
						|
	//     "$ref": "#/responses/ReferenceList"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	getGitRefsInternal(ctx, "")
 | 
						|
}
 | 
						|
 | 
						|
// GetGitRefs get ref or an filteresd list of refs of a repository
 | 
						|
func GetGitRefs(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/git/refs/{ref} repository repoListGitRefs
 | 
						|
	// ---
 | 
						|
	// summary: Get specified ref or filtered repository's refs
 | 
						|
	// 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: ref
 | 
						|
	//   in: path
 | 
						|
	//   description: part or full name of the ref
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/Reference"
 | 
						|
	//     "$ref": "#/responses/ReferenceList"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	getGitRefsInternal(ctx, ctx.Params("*"))
 | 
						|
}
 | 
						|
 | 
						|
func getGitRefs(ctx *context.APIContext, filter string) ([]*git.Reference, string, error) {
 | 
						|
	gitRepo, err := git.OpenRepository(ctx.Repo.Repository.RepoPath())
 | 
						|
	if err != nil {
 | 
						|
		return nil, "OpenRepository", err
 | 
						|
	}
 | 
						|
	defer gitRepo.Close()
 | 
						|
 | 
						|
	if len(filter) > 0 {
 | 
						|
		filter = "refs/" + filter
 | 
						|
	}
 | 
						|
	refs, err := gitRepo.GetRefsFiltered(filter)
 | 
						|
	return refs, "GetRefsFiltered", err
 | 
						|
}
 | 
						|
 | 
						|
func getGitRefsInternal(ctx *context.APIContext, filter string) {
 | 
						|
	refs, lastMethodName, err := getGitRefs(ctx, filter)
 | 
						|
	if err != nil {
 | 
						|
		ctx.Error(http.StatusInternalServerError, lastMethodName, err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if len(refs) == 0 {
 | 
						|
		ctx.NotFound()
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	apiRefs := make([]*api.Reference, len(refs))
 | 
						|
	for i := range refs {
 | 
						|
		apiRefs[i] = &api.Reference{
 | 
						|
			Ref: refs[i].Name,
 | 
						|
			URL: ctx.Repo.Repository.APIURL() + "/git/" + refs[i].Name,
 | 
						|
			Object: &api.GitObject{
 | 
						|
				SHA:  refs[i].Object.String(),
 | 
						|
				Type: refs[i].Type,
 | 
						|
				URL:  ctx.Repo.Repository.APIURL() + "/git/" + refs[i].Type + "s/" + refs[i].Object.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(http.StatusOK, &apiRefs[0])
 | 
						|
		return
 | 
						|
	}
 | 
						|
	ctx.JSON(http.StatusOK, &apiRefs)
 | 
						|
}
 |