mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-11-03 21:16:26 +01:00 
			
		
		
		
	Addition to #22256 The `convert` package relies heavily on different models which is [disallowed by our definition of modules](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md#design-guideline). This helps to prevent possible import cycles. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
		
			
				
	
	
		
			79 lines
		
	
	
		
			2.0 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			79 lines
		
	
	
		
			2.0 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2021 The Gitea Authors. All rights reserved.
 | 
						|
// SPDX-License-Identifier: MIT
 | 
						|
 | 
						|
package repo
 | 
						|
 | 
						|
import (
 | 
						|
	"fmt"
 | 
						|
	"net/http"
 | 
						|
 | 
						|
	"code.gitea.io/gitea/modules/context"
 | 
						|
	"code.gitea.io/gitea/modules/git"
 | 
						|
	api "code.gitea.io/gitea/modules/structs"
 | 
						|
	"code.gitea.io/gitea/services/convert"
 | 
						|
)
 | 
						|
 | 
						|
// GetNote Get a note corresponding to a single commit from a repository
 | 
						|
func GetNote(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/git/notes/{sha} repository repoGetNote
 | 
						|
	// ---
 | 
						|
	// summary: Get a note corresponding to a single commit from a repository
 | 
						|
	// 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: sha
 | 
						|
	//   in: path
 | 
						|
	//   description: a git ref or commit sha
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/Note"
 | 
						|
	//   "422":
 | 
						|
	//     "$ref": "#/responses/validationError"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	sha := ctx.Params(":sha")
 | 
						|
	if !git.IsValidRefPattern(sha) {
 | 
						|
		ctx.Error(http.StatusUnprocessableEntity, "no valid ref or sha", fmt.Sprintf("no valid ref or sha: %s", sha))
 | 
						|
		return
 | 
						|
	}
 | 
						|
	getNote(ctx, sha)
 | 
						|
}
 | 
						|
 | 
						|
func getNote(ctx *context.APIContext, identifier string) {
 | 
						|
	if ctx.Repo.GitRepo == nil {
 | 
						|
		ctx.InternalServerError(fmt.Errorf("no open git repo"))
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	var note git.Note
 | 
						|
	if err := git.GetNote(ctx, ctx.Repo.GitRepo, identifier, ¬e); err != nil {
 | 
						|
		if git.IsErrNotExist(err) {
 | 
						|
			ctx.NotFound(identifier)
 | 
						|
			return
 | 
						|
		}
 | 
						|
		ctx.Error(http.StatusInternalServerError, "GetNote", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	cmt, err := convert.ToCommit(ctx.Repo.Repository, ctx.Repo.GitRepo, note.Commit, nil, true)
 | 
						|
	if err != nil {
 | 
						|
		ctx.Error(http.StatusInternalServerError, "ToCommit", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	apiNote := api.Note{Message: string(note.Message), Commit: cmt}
 | 
						|
	ctx.JSON(http.StatusOK, apiNote)
 | 
						|
}
 |