140 lines
6.3 KiB
Ruby
140 lines
6.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module API
|
|
class Notes < ::API::Base
|
|
include PaginationParams
|
|
helpers ::API::Helpers::NotesHelpers
|
|
|
|
before { authenticate! }
|
|
|
|
urgency :low, [
|
|
'/projects/:id/merge_requests/:noteable_id/notes',
|
|
'/projects/:id/merge_requests/:noteable_id/notes/:note_id'
|
|
]
|
|
|
|
Helpers::NotesHelpers.feature_category_per_noteable_type.each do |noteable_type, feature_category|
|
|
parent_type = noteable_type.parent_class.to_s.underscore
|
|
noteables_str = noteable_type.to_s.underscore.pluralize
|
|
|
|
params do
|
|
requires :id, type: String, desc: "The ID of a #{parent_type}"
|
|
end
|
|
resource parent_type.pluralize.to_sym, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
|
desc "Get a list of #{noteable_type.to_s.downcase} notes" do
|
|
success Entities::Note
|
|
end
|
|
params do
|
|
requires :noteable_id, type: Integer, desc: 'The ID of the noteable'
|
|
optional :order_by, type: String, values: %w[created_at updated_at], default: 'created_at',
|
|
desc: 'Return notes ordered by `created_at` or `updated_at` fields.'
|
|
optional :sort, type: String, values: %w[asc desc], default: 'desc',
|
|
desc: 'Return notes sorted in `asc` or `desc` order.'
|
|
optional :activity_filter, type: String, values: UserPreference::NOTES_FILTERS.stringify_keys.keys, default: 'all_notes',
|
|
desc: 'The type of notables which are returned.'
|
|
use :pagination
|
|
end
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
|
get ":id/#{noteables_str}/:noteable_id/notes", feature_category: feature_category do
|
|
noteable = find_noteable(noteable_type, params[:noteable_id])
|
|
|
|
# We exclude notes that are cross-references and that cannot be viewed
|
|
# by the current user. By doing this exclusion at this level and not
|
|
# at the DB query level (which we cannot in that case), the current
|
|
# page can have less elements than :per_page even if
|
|
# there's more than one page.
|
|
notes_filter = UserPreference::NOTES_FILTERS[params[:activity_filter].to_sym]
|
|
raw_notes = noteable.notes.with_metadata.with_notes_filter(notes_filter).reorder(order_options_with_tie_breaker)
|
|
|
|
# paginate() only works with a relation. This could lead to a
|
|
# mismatch between the pagination headers info and the actual notes
|
|
# array returned, but this is really a edge-case.
|
|
notes = paginate(raw_notes)
|
|
notes = prepare_notes_for_rendering(notes)
|
|
notes = notes.select { |note| note.readable_by?(current_user) }
|
|
present notes, with: Entities::Note
|
|
end
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
|
|
|
desc "Get a single #{noteable_type.to_s.downcase} note" do
|
|
success Entities::Note
|
|
end
|
|
params do
|
|
requires :note_id, type: Integer, desc: 'The ID of a note'
|
|
requires :noteable_id, type: Integer, desc: 'The ID of the noteable'
|
|
end
|
|
get ":id/#{noteables_str}/:noteable_id/notes/:note_id", feature_category: feature_category do
|
|
noteable = find_noteable(noteable_type, params[:noteable_id])
|
|
get_note(noteable, params[:note_id])
|
|
end
|
|
|
|
desc "Create a new #{noteable_type.to_s.downcase} note" do
|
|
success Entities::Note
|
|
end
|
|
params do
|
|
requires :noteable_id, type: Integer, desc: 'The ID of the noteable'
|
|
requires :body, type: String, desc: 'The content of a note'
|
|
optional :confidential, type: Boolean, desc: '[Deprecated in 15.5] Renamed to internal'
|
|
optional :internal, type: Boolean, desc: 'Internal note flag, default is false'
|
|
optional :created_at, type: String, desc: 'The creation date of the note'
|
|
optional :merge_request_diff_head_sha, type: String, desc: 'The SHA of the head commit'
|
|
end
|
|
post ":id/#{noteables_str}/:noteable_id/notes", feature_category: feature_category do
|
|
allowlist =
|
|
Gitlab::CurrentSettings.current_application_settings.notes_create_limit_allowlist
|
|
check_rate_limit! :notes_create, scope: current_user, users_allowlist: allowlist
|
|
noteable = find_noteable(noteable_type, params[:noteable_id])
|
|
|
|
opts = {
|
|
note: params[:body],
|
|
noteable_type: noteables_str.classify,
|
|
noteable_id: noteable.id,
|
|
internal: params[:internal] || params[:confidential],
|
|
created_at: params[:created_at],
|
|
merge_request_diff_head_sha: params[:merge_request_diff_head_sha]
|
|
}
|
|
|
|
note = create_note(noteable, opts)
|
|
|
|
if note.errors.attribute_names == [:commands_only, :command_names]
|
|
status 202
|
|
present note, with: Entities::NoteCommands
|
|
elsif note.valid?
|
|
present note, with: Entities.const_get(note.class.name, false)
|
|
else
|
|
note.errors.delete(:commands_only) if note.errors.has_key?(:commands)
|
|
bad_request!("Note #{note.errors.messages}")
|
|
end
|
|
end
|
|
|
|
desc "Update an existing #{noteable_type.to_s.downcase} note" do
|
|
success Entities::Note
|
|
end
|
|
params do
|
|
requires :noteable_id, type: Integer, desc: 'The ID of the noteable'
|
|
requires :note_id, type: Integer, desc: 'The ID of a note'
|
|
optional :body, type: String, allow_blank: false, desc: 'The content of a note'
|
|
optional :confidential, type: Boolean, desc: '[Deprecated in 14.10] No longer allowed to update confidentiality of notes'
|
|
end
|
|
put ":id/#{noteables_str}/:noteable_id/notes/:note_id", feature_category: feature_category do
|
|
noteable = find_noteable(noteable_type, params[:noteable_id])
|
|
|
|
update_note(noteable, params[:note_id])
|
|
end
|
|
|
|
desc "Delete a #{noteable_type.to_s.downcase} note" do
|
|
success Entities::Note
|
|
end
|
|
params do
|
|
requires :noteable_id, type: Integer, desc: 'The ID of the noteable'
|
|
requires :note_id, type: Integer, desc: 'The ID of a note'
|
|
end
|
|
delete ":id/#{noteables_str}/:noteable_id/notes/:note_id" do
|
|
noteable = find_noteable(noteable_type, params[:noteable_id])
|
|
|
|
delete_note(noteable, params[:note_id])
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|