summaryrefslogtreecommitdiffstats
path: root/routers/api/v1/misc/gitignore.go
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--routers/api/v1/misc/gitignore.go56
1 files changed, 56 insertions, 0 deletions
diff --git a/routers/api/v1/misc/gitignore.go b/routers/api/v1/misc/gitignore.go
new file mode 100644
index 0000000..dffd771
--- /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/options"
+ repo_module "code.gitea.io/gitea/modules/repository"
+ "code.gitea.io/gitea/modules/structs"
+ "code.gitea.io/gitea/modules/util"
+ "code.gitea.io/gitea/services/context"
+)
+
+// 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)})
+}