diff options
| author | Antoine GIRARD <sapk@users.noreply.github.com> | 2017-08-21 13:13:47 +0200 |
|---|---|---|
| committer | Lauris BH <lauris@nix.lv> | 2017-08-21 14:13:47 +0300 |
| commit | fd8e8a421ae21f8c68eaad195bdd4881e1d34b21 (patch) | |
| tree | 2c651e0f39a0360496d1fbbd1f4d0fd03ec9a95f /routers/api/v1/org/hook.go | |
| parent | 951c909a67bb6f1f8577fb1e61f22dca2bc3c07f (diff) | |
| download | gitea-fd8e8a421ae21f8c68eaad195bdd4881e1d34b21.tar.gz gitea-fd8e8a421ae21f8c68eaad195bdd4881e1d34b21.zip | |
Improve swagger doc (#2274)
* Add swagger comment for adminCreateOrg
* Add swagger comment for admin route
* add hook swagger doc
* Add tags
* Add auth
* Fix name of responses
* Edit name method
* Update vendor
* make generate-swagger
Diffstat (limited to 'routers/api/v1/org/hook.go')
| -rw-r--r-- | routers/api/v1/org/hook.go | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/routers/api/v1/org/hook.go b/routers/api/v1/org/hook.go index 3a0b74ac21..d8a4c45fc8 100644 --- a/routers/api/v1/org/hook.go +++ b/routers/api/v1/org/hook.go @@ -15,6 +15,15 @@ import ( // ListHooks list an organziation's webhooks func ListHooks(ctx *context.APIContext) { + // swagger:route GET /orgs/{orgname}/hooks organization orgListHooks + // + // Produces: + // - application/json + // + // Responses: + // 200: HookList + // 500: error + org := ctx.Org.Organization orgHooks, err := models.GetWebhooksByOrgID(org.ID) if err != nil { @@ -30,6 +39,16 @@ func ListHooks(ctx *context.APIContext) { // GetHook get an organization's hook by id func GetHook(ctx *context.APIContext) { + // swagger:route GET /orgs/{orgname}/hooks/{id} organization orgGetHook + // + // Produces: + // - application/json + // + // Responses: + // 200: Hook + // 404: notFound + // 500: error + org := ctx.Org.Organization hookID := ctx.ParamsInt64(":id") hook, err := utils.GetOrgHook(ctx, org.ID, hookID) @@ -41,6 +60,19 @@ func GetHook(ctx *context.APIContext) { // CreateHook create a hook for an organization func CreateHook(ctx *context.APIContext, form api.CreateHookOption) { + // swagger:route POST /orgs/{orgname}/hooks/ organization orgCreateHook + // + // Consumes: + // - application/json + // + // Produces: + // - application/json + // + // Responses: + // 201: Hook + // 422: validationError + // 500: error + if !utils.CheckCreateHookOption(ctx, &form) { return } @@ -49,12 +81,36 @@ func CreateHook(ctx *context.APIContext, form api.CreateHookOption) { // EditHook modify a hook of a repository func EditHook(ctx *context.APIContext, form api.EditHookOption) { + // swagger:route PATCH /orgs/{orgname}/hooks/{id} organization orgEditHook + // + // Consumes: + // - application/json + // + // Produces: + // - application/json + // + // Responses: + // 200: Hook + // 422: validationError + // 404: notFound + // 500: error + hookID := ctx.ParamsInt64(":id") utils.EditOrgHook(ctx, &form, hookID) } // DeleteHook delete a hook of an organization func DeleteHook(ctx *context.APIContext) { + // swagger:route DELETE /orgs/{orgname}/hooks/{id} organization orgDeleteHook + // + // Produces: + // - application/json + // + // Responses: + // 204: empty + // 404: notFound + // 500: error + org := ctx.Org.Organization hookID := ctx.ParamsInt64(":id") if err := models.DeleteWebhookByOrgID(org.ID, hookID); err != nil { |