0
0
Fork 0
mirror of https://github.com/go-gitea/gitea synced 2024-10-31 03:09:26 +01:00
gitea/routers/api/v1/misc/gitignore.go
JakobDev 36a5d4c2f3
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
2023-04-27 11:51:20 +08:00

56 lines
1.5 KiB
Go

// 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)})
}