summaryrefslogtreecommitdiffstats
path: root/routers/api/v1/repo/git_hook.go
diff options
context:
space:
mode:
authorSegev Finer <segev208@gmail.com>2019-04-17 08:31:08 +0300
committertechknowlogick <matti@mdranta.net>2019-04-17 01:31:08 -0400
commit34548369e1d78eb1141aecd4ab02acf59f2949ae (patch)
tree77ab26b7f7c7c4e53b604a8c4eec8d2a502b4af8 /routers/api/v1/repo/git_hook.go
parent827ab6b75a70a3cd90033a4d49bb44c635dd3310 (diff)
downloadgitea-34548369e1d78eb1141aecd4ab02acf59f2949ae.tar.gz
gitea-34548369e1d78eb1141aecd4ab02acf59f2949ae.zip
Add API for manipulating Git hooks (#6436)
* Add API for manipulating Git hooks Signed-off-by: Segev Finer <segev@codeocean.com> * Replace code.gitea.io/sdk with PR branch temporarily for CI * Switch back to code.gitea.io/sdk@master * Return 403 instead of 404 on no permission to edit hooks in API * Add tests for Git hooks API * Update models/repo_list_test.go Co-Authored-By: segevfiner <segev208@gmail.com> * Update models/repo_list_test.go Co-Authored-By: segevfiner <segev208@gmail.com> * empty line
Diffstat (limited to 'routers/api/v1/repo/git_hook.go')
-rw-r--r--routers/api/v1/repo/git_hook.go187
1 files changed, 187 insertions, 0 deletions
diff --git a/routers/api/v1/repo/git_hook.go b/routers/api/v1/repo/git_hook.go
new file mode 100644
index 0000000000..b7a8691cd3
--- /dev/null
+++ b/routers/api/v1/repo/git_hook.go
@@ -0,0 +1,187 @@
+// Copyright 2019 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package repo
+
+import (
+ "code.gitea.io/gitea/modules/context"
+ "code.gitea.io/gitea/modules/git"
+ "code.gitea.io/gitea/routers/api/v1/convert"
+ api "code.gitea.io/sdk/gitea"
+)
+
+// ListGitHooks list all Git hooks of a repository
+func ListGitHooks(ctx *context.APIContext) {
+ // swagger:operation GET /repos/{owner}/{repo}/hooks/git repository repoListGitHooks
+ // ---
+ // summary: List the Git hooks in 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
+ // responses:
+ // "200":
+ // "$ref": "#/responses/GitHookList"
+ hooks, err := ctx.Repo.GitRepo.Hooks()
+ if err != nil {
+ ctx.Error(500, "Hooks", err)
+ return
+ }
+
+ apiHooks := make([]*api.GitHook, len(hooks))
+ for i := range hooks {
+ apiHooks[i] = convert.ToGitHook(hooks[i])
+ }
+ ctx.JSON(200, &apiHooks)
+}
+
+// GetGitHook get a repo's Git hook by id
+func GetGitHook(ctx *context.APIContext) {
+ // swagger:operation GET /repos/{owner}/{repo}/hooks/git/{id} repository repoGetGitHook
+ // ---
+ // summary: Get a Git hook
+ // 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: id
+ // in: path
+ // description: id of the hook to get
+ // type: string
+ // required: true
+ // responses:
+ // "200":
+ // "$ref": "#/responses/GitHook"
+ // "404":
+ // "$ref": "#/responses/notFound"
+ hookID := ctx.Params(":id")
+ hook, err := ctx.Repo.GitRepo.GetHook(hookID)
+ if err != nil {
+ if err == git.ErrNotValidHook {
+ ctx.NotFound()
+ } else {
+ ctx.Error(500, "GetHook", err)
+ }
+ return
+ }
+ ctx.JSON(200, convert.ToGitHook(hook))
+}
+
+// EditGitHook modify a Git hook of a repository
+func EditGitHook(ctx *context.APIContext, form api.EditGitHookOption) {
+ // swagger:operation PATCH /repos/{owner}/{repo}/hooks/git/{id} repository repoEditGitHook
+ // ---
+ // summary: Edit a Git hook in 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: id
+ // in: path
+ // description: id of the hook to get
+ // type: string
+ // required: true
+ // - name: body
+ // in: body
+ // schema:
+ // "$ref": "#/definitions/EditGitHookOption"
+ // responses:
+ // "200":
+ // "$ref": "#/responses/GitHook"
+ // "404":
+ // "$ref": "#/responses/notFound"
+ hookID := ctx.Params(":id")
+ hook, err := ctx.Repo.GitRepo.GetHook(hookID)
+ if err != nil {
+ if err == git.ErrNotValidHook {
+ ctx.NotFound()
+ } else {
+ ctx.Error(500, "GetHook", err)
+ }
+ return
+ }
+
+ hook.Content = form.Content
+ if err = hook.Update(); err != nil {
+ ctx.Error(500, "hook.Update", err)
+ return
+ }
+
+ ctx.JSON(200, convert.ToGitHook(hook))
+}
+
+// DeleteGitHook delete a Git hook of a repository
+func DeleteGitHook(ctx *context.APIContext) {
+ // swagger:operation DELETE /repos/{owner}/{repo}/hooks/git/{id} repository repoDeleteGitHook
+ // ---
+ // summary: Delete a Git hook in 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: id
+ // in: path
+ // description: id of the hook to get
+ // type: string
+ // required: true
+ // responses:
+ // "204":
+ // "$ref": "#/responses/empty"
+ // "404":
+ // "$ref": "#/responses/notFound"
+ hookID := ctx.Params(":id")
+ hook, err := ctx.Repo.GitRepo.GetHook(hookID)
+ if err != nil {
+ if err == git.ErrNotValidHook {
+ ctx.NotFound()
+ } else {
+ ctx.Error(500, "GetHook", err)
+ }
+ return
+ }
+
+ hook.Content = ""
+ if err = hook.Update(); err != nil {
+ ctx.Error(500, "hook.Update", err)
+ return
+ }
+
+ ctx.Status(204)
+}