113 lines
3.7 KiB
Ruby
113 lines
3.7 KiB
Ruby
module Gitlab
|
|
# 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
|
|
@notes = user_project.notes.common
|
|
present paginate(@notes), with: Entities::Note
|
|
end
|
|
|
|
# Get a single project wall note
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# note_id (required) - The ID of a note
|
|
# Example Request:
|
|
# GET /projects/:id/notes/:note_id
|
|
get ":id/notes/:note_id" do
|
|
@note = user_project.notes.common.find(params[:note_id])
|
|
present @note, with: Entities::Note
|
|
end
|
|
|
|
# Create a new project wall note
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# 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
|
|
|
|
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!
|
|
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:
|
|
# 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
|
|
|
|
# Get a single +noteable+ note
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# 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
|
|
|
|
# Create a new +noteable+ note
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# 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
|
|
|
|
if @note.save
|
|
present @note, with: Entities::Note
|
|
else
|
|
not_found!
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|