mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 08:30:25 +08:00 
			
		
		
		
	Add API for gitignore templates (#22783)
This implements the [Gitignores template API of GitHub](https://docs.github.com/en/rest/gitignore?apiVersion=2022-11-28) in Gitea
This commit is contained in:
		@@ -719,6 +719,8 @@ func Routes(ctx gocontext.Context) *web.Route {
 | 
			
		||||
		m.Post("/markup", bind(api.MarkupOption{}), misc.Markup)
 | 
			
		||||
		m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
 | 
			
		||||
		m.Post("/markdown/raw", misc.MarkdownRaw)
 | 
			
		||||
		m.Get("/gitignore/templates", misc.ListGitignoresTemplates)
 | 
			
		||||
		m.Get("/gitignore/templates/{name}", misc.GetGitignoreTemplateInfo)
 | 
			
		||||
		m.Get("/licenses", misc.ListLicenseTemplates)
 | 
			
		||||
		m.Get("/licenses/{name}", misc.GetLicenseTemplateInfo)
 | 
			
		||||
		m.Group("/settings", func() {
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										56
									
								
								routers/api/v1/misc/gitignore.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										56
									
								
								routers/api/v1/misc/gitignore.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,56 @@
 | 
			
		||||
// Copyright 2023 The Gitea Authors. All rights reserved.
 | 
			
		||||
// SPDX-License-Identifier: MIT
 | 
			
		||||
 | 
			
		||||
package misc
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"net/http"
 | 
			
		||||
 | 
			
		||||
	"code.gitea.io/gitea/modules/context"
 | 
			
		||||
	"code.gitea.io/gitea/modules/options"
 | 
			
		||||
	repo_module "code.gitea.io/gitea/modules/repository"
 | 
			
		||||
	"code.gitea.io/gitea/modules/structs"
 | 
			
		||||
	"code.gitea.io/gitea/modules/util"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Shows a list of all Gitignore templates
 | 
			
		||||
func ListGitignoresTemplates(ctx *context.APIContext) {
 | 
			
		||||
	// swagger:operation GET /gitignore/templates miscellaneous listGitignoresTemplates
 | 
			
		||||
	// ---
 | 
			
		||||
	// summary: Returns a list of all gitignore templates
 | 
			
		||||
	// produces:
 | 
			
		||||
	// - application/json
 | 
			
		||||
	// responses:
 | 
			
		||||
	//   "200":
 | 
			
		||||
	//     "$ref": "#/responses/GitignoreTemplateList"
 | 
			
		||||
	ctx.JSON(http.StatusOK, repo_module.Gitignores)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SHows information about a gitignore template
 | 
			
		||||
func GetGitignoreTemplateInfo(ctx *context.APIContext) {
 | 
			
		||||
	// swagger:operation GET /gitignore/templates/{name} miscellaneous getGitignoreTemplateInfo
 | 
			
		||||
	// ---
 | 
			
		||||
	// summary: Returns information about a gitignore template
 | 
			
		||||
	// produces:
 | 
			
		||||
	// - application/json
 | 
			
		||||
	// parameters:
 | 
			
		||||
	// - name: name
 | 
			
		||||
	//   in: path
 | 
			
		||||
	//   description: name of the template
 | 
			
		||||
	//   type: string
 | 
			
		||||
	//   required: true
 | 
			
		||||
	// responses:
 | 
			
		||||
	//   "200":
 | 
			
		||||
	//     "$ref": "#/responses/GitignoreTemplateInfo"
 | 
			
		||||
	//   "404":
 | 
			
		||||
	//     "$ref": "#/responses/notFound"
 | 
			
		||||
	name := util.PathJoinRelX(ctx.Params("name"))
 | 
			
		||||
 | 
			
		||||
	text, err := options.Gitignore(name)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		ctx.NotFound()
 | 
			
		||||
		return
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	ctx.JSON(http.StatusOK, &structs.GitignoreTemplateInfo{Name: name, Source: string(text)})
 | 
			
		||||
}
 | 
			
		||||
@@ -14,6 +14,20 @@ type swaggerResponseServerVersion struct {
 | 
			
		||||
	Body api.ServerVersion `json:"body"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GitignoreTemplateList
 | 
			
		||||
// swagger:response GitignoreTemplateList
 | 
			
		||||
type swaggerResponseGitignoreTemplateList struct {
 | 
			
		||||
	// in:body
 | 
			
		||||
	Body []string `json:"body"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GitignoreTemplateInfo
 | 
			
		||||
// swagger:response GitignoreTemplateInfo
 | 
			
		||||
type swaggerResponseGitignoreTemplateInfo struct {
 | 
			
		||||
	// in:body
 | 
			
		||||
	Body api.GitignoreTemplateInfo `json:"body"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// LicenseTemplateList
 | 
			
		||||
// swagger:response LicenseTemplateList
 | 
			
		||||
type swaggerResponseLicensesTemplateList struct {
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user