summaryrefslogtreecommitdiffstats
path: root/routers
diff options
context:
space:
mode:
authorJakobDev <jakobdev@gmx.de>2023-04-27 05:51:20 +0200
committerGitHub <noreply@github.com>2023-04-27 11:51:20 +0800
commit36a5d4c2f3b5670e5e921034cd5d25817534a6d4 (patch)
tree373c7b9bdfa4bdaaf1552dcbe1094723d2bd7b09 /routers
parent50133b02bd381b7ee4da1ec4b7b637d5b7552678 (diff)
downloadgitea-36a5d4c2f3b5670e5e921034cd5d25817534a6d4.tar.gz
gitea-36a5d4c2f3b5670e5e921034cd5d25817534a6d4.zip
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
Diffstat (limited to 'routers')
-rw-r--r--routers/api/v1/api.go2
-rw-r--r--routers/api/v1/misc/gitignore.go56
-rw-r--r--routers/api/v1/swagger/misc.go14
3 files changed, 72 insertions, 0 deletions
diff --git a/routers/api/v1/api.go b/routers/api/v1/api.go
index 0af095b2bb..9a733b832f 100644
--- a/routers/api/v1/api.go
+++ b/routers/api/v1/api.go
@@ -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() {
diff --git a/routers/api/v1/misc/gitignore.go b/routers/api/v1/misc/gitignore.go
new file mode 100644
index 0000000000..7c7fe4b125
--- /dev/null
+++ b/routers/api/v1/misc/gitignore.go
@@ -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)})
+}
diff --git a/routers/api/v1/swagger/misc.go b/routers/api/v1/swagger/misc.go
index 322bad0c1c..5778b659b5 100644
--- a/routers/api/v1/swagger/misc.go
+++ b/routers/api/v1/swagger/misc.go
@@ -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 {