2018-09-29 22:34:47 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2013-06-06 09:37:51 +00:00
|
|
|
module API
|
2020-10-15 00:08:42 +00:00
|
|
|
class ProjectHooks < ::API::Base
|
2016-12-04 17:11:19 +00:00
|
|
|
include PaginationParams
|
|
|
|
|
2022-11-03 18:11:17 +00:00
|
|
|
project_hooks_tags = %w[project_hooks]
|
|
|
|
|
2016-12-04 17:11:19 +00:00
|
|
|
before { authenticate! }
|
|
|
|
before { authorize_admin_project }
|
|
|
|
|
2020-10-30 15:08:59 +00:00
|
|
|
feature_category :integrations
|
|
|
|
|
2022-06-23 12:09:30 +00:00
|
|
|
helpers ::API::Helpers::WebHooksHelpers
|
|
|
|
|
2016-10-31 13:56:53 +00:00
|
|
|
helpers do
|
2022-06-23 12:09:30 +00:00
|
|
|
def hook_scope
|
|
|
|
user_project.hooks
|
|
|
|
end
|
|
|
|
|
|
|
|
params :common_hook_parameters do
|
2016-10-31 13:56:53 +00:00
|
|
|
optional :push_events, type: Boolean, desc: "Trigger hook on push events"
|
|
|
|
optional :issues_events, type: Boolean, desc: "Trigger hook on issues events"
|
2018-02-26 17:35:04 +00:00
|
|
|
optional :confidential_issues_events, type: Boolean, desc: "Trigger hook on confidential issues events"
|
2016-10-31 13:56:53 +00:00
|
|
|
optional :merge_requests_events, type: Boolean, desc: "Trigger hook on merge request events"
|
|
|
|
optional :tag_push_events, type: Boolean, desc: "Trigger hook on tag push events"
|
2022-06-23 12:09:30 +00:00
|
|
|
optional :note_events, type: Boolean, desc: "Trigger hook on note (comment) events"
|
|
|
|
optional :confidential_note_events, type: Boolean, desc: "Trigger hook on confidential note (comment) events"
|
2017-04-10 10:05:29 +00:00
|
|
|
optional :job_events, type: Boolean, desc: "Trigger hook on job events"
|
2016-10-31 13:56:53 +00:00
|
|
|
optional :pipeline_events, type: Boolean, desc: "Trigger hook on pipeline events"
|
2017-01-03 20:07:12 +00:00
|
|
|
optional :wiki_page_events, type: Boolean, desc: "Trigger hook on wiki events"
|
2020-08-11 21:10:09 +00:00
|
|
|
optional :deployment_events, type: Boolean, desc: "Trigger hook on deployment events"
|
2020-11-07 00:08:58 +00:00
|
|
|
optional :releases_events, type: Boolean, desc: "Trigger hook on release events"
|
2016-10-31 13:56:53 +00:00
|
|
|
optional :enable_ssl_verification, type: Boolean, desc: "Do SSL verification when triggering the hook"
|
|
|
|
optional :token, type: String, desc: "Secret token to validate received payloads; this will not be returned in the response"
|
2018-06-07 07:35:17 +00:00
|
|
|
optional :push_events_branch_filter, type: String, desc: "Trigger hook on specified branch only"
|
2022-06-23 12:09:30 +00:00
|
|
|
use :url_variables
|
2016-10-31 13:56:53 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-10-18 17:27:10 +00:00
|
|
|
params do
|
2022-11-03 15:11:31 +00:00
|
|
|
requires :id, types: [String, Integer], desc: 'The ID or URL-encoded path of the project'
|
2016-10-18 17:27:10 +00:00
|
|
|
end
|
2018-11-08 12:18:17 +00:00
|
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
2022-06-23 12:09:30 +00:00
|
|
|
namespace ':id/hooks' do
|
|
|
|
mount ::API::Hooks::UrlVariables
|
|
|
|
end
|
|
|
|
|
2022-11-03 18:11:17 +00:00
|
|
|
desc 'List project hooks' do
|
|
|
|
detail 'Get a list of project hooks'
|
2016-10-18 17:27:10 +00:00
|
|
|
success Entities::ProjectHook
|
2022-11-03 18:11:17 +00:00
|
|
|
is_array true
|
|
|
|
tags project_hooks_tags
|
2016-10-18 17:27:10 +00:00
|
|
|
end
|
2016-12-04 17:11:19 +00:00
|
|
|
params do
|
|
|
|
use :pagination
|
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
get ":id/hooks" do
|
2017-01-17 04:45:07 +00:00
|
|
|
present paginate(user_project.hooks), with: Entities::ProjectHook
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
|
2022-11-03 18:11:17 +00:00
|
|
|
desc 'Get project hook' do
|
|
|
|
detail 'Get a specific hook for a project'
|
2016-10-18 17:27:10 +00:00
|
|
|
success Entities::ProjectHook
|
2022-11-03 18:11:17 +00:00
|
|
|
failure [
|
|
|
|
{ code: 404, message: 'Not found' }
|
|
|
|
]
|
|
|
|
tags project_hooks_tags
|
2016-10-18 17:27:10 +00:00
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :hook_id, type: Integer, desc: 'The ID of a project hook'
|
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
get ":id/hooks/:hook_id" do
|
2016-10-18 17:27:10 +00:00
|
|
|
hook = user_project.hooks.find(params[:hook_id])
|
|
|
|
present hook, with: Entities::ProjectHook
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
|
2022-11-03 18:11:17 +00:00
|
|
|
desc 'Add project hook' do
|
|
|
|
detail 'Adds a hook to a specified project'
|
2016-10-18 17:27:10 +00:00
|
|
|
success Entities::ProjectHook
|
2022-11-03 18:11:17 +00:00
|
|
|
failure [
|
|
|
|
{ code: 400, message: 'Validation error' },
|
|
|
|
{ code: 404, message: 'Not found' },
|
|
|
|
{ code: 422, message: 'Unprocessable entity' }
|
|
|
|
]
|
|
|
|
tags project_hooks_tags
|
2016-10-18 17:27:10 +00:00
|
|
|
end
|
|
|
|
params do
|
2022-06-23 12:09:30 +00:00
|
|
|
use :requires_url
|
|
|
|
use :common_hook_parameters
|
2016-10-18 17:27:10 +00:00
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
post ":id/hooks" do
|
2022-06-23 12:09:30 +00:00
|
|
|
hook_params = create_hook_params
|
2017-04-10 10:05:29 +00:00
|
|
|
hook = user_project.hooks.new(hook_params)
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2022-06-23 12:09:30 +00:00
|
|
|
save_hook(hook, Entities::ProjectHook)
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
|
2022-11-03 18:11:17 +00:00
|
|
|
desc 'Edit project hook' do
|
|
|
|
detail 'Edits a hook for a specified project.'
|
2016-10-18 17:27:10 +00:00
|
|
|
success Entities::ProjectHook
|
2022-11-03 18:11:17 +00:00
|
|
|
failure [
|
|
|
|
{ code: 400, message: 'Validation error' },
|
|
|
|
{ code: 404, message: 'Not found' },
|
|
|
|
{ code: 422, message: 'Unprocessable entity' }
|
|
|
|
]
|
|
|
|
tags project_hooks_tags
|
2016-10-18 17:27:10 +00:00
|
|
|
end
|
|
|
|
params do
|
2022-11-03 18:11:17 +00:00
|
|
|
requires :hook_id, type: Integer, desc: 'The ID of the project hook'
|
2022-06-23 12:09:30 +00:00
|
|
|
use :optional_url
|
|
|
|
use :common_hook_parameters
|
2016-10-18 17:27:10 +00:00
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
put ":id/hooks/:hook_id" do
|
2022-06-23 12:09:30 +00:00
|
|
|
update_hook(entity: Entities::ProjectHook)
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
|
2022-11-03 18:11:17 +00:00
|
|
|
desc 'Delete a project hook' do
|
|
|
|
detail 'Removes a hook from a project. This is an idempotent method and can be called multiple times. Either the hook is available or not.'
|
2016-10-18 17:27:10 +00:00
|
|
|
success Entities::ProjectHook
|
2022-11-03 18:11:17 +00:00
|
|
|
failure [
|
|
|
|
{ code: 404, message: 'Not found' }
|
|
|
|
]
|
|
|
|
tags project_hooks_tags
|
2016-10-18 17:27:10 +00:00
|
|
|
end
|
|
|
|
params do
|
2022-11-03 18:11:17 +00:00
|
|
|
requires :hook_id, type: Integer, desc: 'The ID of the project hook'
|
2016-10-18 17:27:10 +00:00
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
delete ":id/hooks/:hook_id" do
|
2022-06-23 12:09:30 +00:00
|
|
|
hook = find_hook
|
2017-02-20 18:18:12 +00:00
|
|
|
|
2020-10-07 09:09:13 +00:00
|
|
|
destroy_conditionally!(hook) do
|
|
|
|
WebHooks::DestroyService.new(current_user).execute(hook)
|
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|