2019-02-15 15:39:39 +05:30
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
module API
|
2021-01-03 14:25:43 +05:30
|
|
|
class Suggestions < ::API::Base
|
2019-02-15 15:39:39 +05:30
|
|
|
before { authenticate! }
|
|
|
|
|
2021-01-29 00:20:46 +05:30
|
|
|
feature_category :code_review
|
|
|
|
|
2019-02-15 15:39:39 +05:30
|
|
|
resource :suggestions do
|
|
|
|
desc 'Apply suggestion patch in the Merge Request it was created' do
|
|
|
|
success Entities::Suggestion
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :id, type: String, desc: 'The suggestion ID'
|
2021-03-11 19:13:27 +05:30
|
|
|
optional :commit_message, type: String, desc: "A custom commit message to use instead of the default generated message or the project's default message"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
2022-01-26 12:08:38 +05:30
|
|
|
put ':id/apply', urgency: :low do
|
2019-02-15 15:39:39 +05:30
|
|
|
suggestion = Suggestion.find_by_id(params[:id])
|
|
|
|
|
2020-06-23 00:09:42 +05:30
|
|
|
if suggestion
|
2021-03-11 19:13:27 +05:30
|
|
|
apply_suggestions(suggestion, current_user, params[:commit_message])
|
2020-06-23 00:09:42 +05:30
|
|
|
else
|
|
|
|
render_api_error!(_('Suggestion is not applicable as the suggestion was not found.'), :not_found)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Apply multiple suggestion patches in the Merge Request where they were created' do
|
|
|
|
success Entities::Suggestion
|
|
|
|
end
|
|
|
|
params do
|
2020-07-28 23:09:34 +05:30
|
|
|
requires :ids, type: Array[Integer], coerce_with: ::API::Validations::Types::CommaSeparatedToIntegerArray.coerce, desc: "An array of suggestion ID's"
|
2021-03-11 19:13:27 +05:30
|
|
|
optional :commit_message, type: String, desc: "A custom commit message to use instead of the default generated message or the project's default message"
|
2020-06-23 00:09:42 +05:30
|
|
|
end
|
2022-01-26 12:08:38 +05:30
|
|
|
put 'batch_apply', urgency: :low do
|
2020-06-23 00:09:42 +05:30
|
|
|
ids = params[:ids]
|
|
|
|
|
|
|
|
suggestions = Suggestion.id_in(ids)
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2020-06-23 00:09:42 +05:30
|
|
|
if suggestions.size == ids.length
|
2021-03-11 19:13:27 +05:30
|
|
|
apply_suggestions(suggestions, current_user, params[:commit_message])
|
2020-06-23 00:09:42 +05:30
|
|
|
else
|
|
|
|
render_api_error!(_('Suggestions are not applicable as one or more suggestions were not found.'), :not_found)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
helpers do
|
2021-03-11 19:13:27 +05:30
|
|
|
def apply_suggestions(suggestions, current_user, message)
|
2020-06-23 00:09:42 +05:30
|
|
|
authorize_suggestions(*suggestions)
|
|
|
|
|
2021-03-11 19:13:27 +05:30
|
|
|
result = ::Suggestions::ApplyService.new(current_user, *suggestions, message: message).execute
|
2019-02-15 15:39:39 +05:30
|
|
|
|
|
|
|
if result[:status] == :success
|
2020-06-23 00:09:42 +05:30
|
|
|
present suggestions, with: Entities::Suggestion, current_user: current_user
|
2019-02-15 15:39:39 +05:30
|
|
|
else
|
2020-06-23 00:09:42 +05:30
|
|
|
http_status = result[:http_status] || :bad_request
|
2019-02-15 15:39:39 +05:30
|
|
|
render_api_error!(result[:message], http_status)
|
|
|
|
end
|
|
|
|
end
|
2020-06-23 00:09:42 +05:30
|
|
|
|
|
|
|
def authorize_suggestions(*suggestions)
|
|
|
|
suggestions.each do |suggestion|
|
|
|
|
authorize! :apply_suggestion, suggestion
|
|
|
|
end
|
|
|
|
end
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|