gitlab-org--gitlab-foss/lib/api/notes.rb

117 lines
3.8 KiB
Ruby
Raw Normal View History

module API
# Notes API
class Notes < Grape::API
before { authenticate! }
NOTEABLE_TYPES = [Issue, MergeRequest, Snippet]
resource :projects do
# Get a list of project wall notes
#
# Parameters:
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/notes
get ":id/notes" do
2013-01-04 11:50:31 -05:00
@notes = user_project.notes.common
2013-03-19 06:35:55 -04:00
# Get recent notes if recent = true
@notes = @notes.order('id DESC') if params[:recent]
present paginate(@notes), with: Entities::Note
end
2012-12-01 05:20:45 -05:00
# Get a single project wall note
#
# Parameters:
# id (required) - The ID of a project
2012-12-01 05:20:45 -05:00
# note_id (required) - The ID of a note
# Example Request:
# GET /projects/:id/notes/:note_id
get ":id/notes/:note_id" do
2013-01-04 11:50:31 -05:00
@note = user_project.notes.common.find(params[:note_id])
2012-12-01 05:20:45 -05:00
present @note, with: Entities::Note
end
2012-11-29 18:52:56 -05:00
# Create a new project wall note
#
# Parameters:
# id (required) - The ID of a project
2012-11-29 18:52:56 -05:00
# body (required) - The content of a note
# Example Request:
# POST /projects/:id/notes
post ":id/notes" do
required_attributes! [:body]
@note = user_project.notes.new(note: params[:body])
@note.author = current_user
2012-11-29 18:52:56 -05:00
if @note.save
present @note, with: Entities::Note
else
# :note is exposed as :body, but :note is set on error
bad_request!(:note) if @note.errors[:note].any?
not_found!
2012-11-29 18:52:56 -05:00
end
end
NOTEABLE_TYPES.each do |noteable_type|
noteables_str = noteable_type.to_s.underscore.pluralize
noteable_id_str = "#{noteable_type.to_s.underscore}_id"
# Get a list of project +noteable+ notes
#
# Parameters:
# id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet
# Example Request:
2012-11-29 14:21:14 -05:00
# GET /projects/:id/issues/:noteable_id/notes
# GET /projects/:id/snippets/:noteable_id/notes
get ":id/#{noteables_str}/:#{noteable_id_str}/notes" do
@noteable = user_project.send(:"#{noteables_str}").find(params[:"#{noteable_id_str}"])
present paginate(@noteable.notes), with: Entities::Note
end
2012-11-29 14:33:41 -05:00
# Get a single +noteable+ note
#
# Parameters:
# id (required) - The ID of a project
2012-11-29 14:33:41 -05:00
# noteable_id (required) - The ID of an issue or snippet
# note_id (required) - The ID of a note
# Example Request:
# GET /projects/:id/issues/:noteable_id/notes/:note_id
# GET /projects/:id/snippets/:noteable_id/notes/:note_id
get ":id/#{noteables_str}/:#{noteable_id_str}/notes/:note_id" do
@noteable = user_project.send(:"#{noteables_str}").find(params[:"#{noteable_id_str}"])
@note = @noteable.notes.find(params[:note_id])
present @note, with: Entities::Note
end
2012-11-29 15:06:24 -05:00
# Create a new +noteable+ note
#
# Parameters:
# id (required) - The ID of a project
2012-11-29 15:06:24 -05:00
# noteable_id (required) - The ID of an issue or snippet
# body (required) - The content of a note
# Example Request:
# POST /projects/:id/issues/:noteable_id/notes
# POST /projects/:id/snippets/:noteable_id/notes
post ":id/#{noteables_str}/:#{noteable_id_str}/notes" do
required_attributes! [:body]
@noteable = user_project.send(:"#{noteables_str}").find(params[:"#{noteable_id_str}"])
@note = @noteable.notes.new(note: params[:body])
@note.author = current_user
@note.project = user_project
2012-11-29 15:06:24 -05:00
if @note.save
present @note, with: Entities::Note
else
not_found!
2012-11-29 15:06:24 -05:00
end
end
end
end
end
end