API: list wall, snippet and issue notes

This commit is contained in:
Nihad Abbasov 2012-11-27 11:43:39 -08:00
parent aaa1c94239
commit 01eab583d0
4 changed files with 94 additions and 1 deletions

View file

@ -19,5 +19,6 @@ module Gitlab
mount Milestones
mount Session
mount MergeRequests
mount Notes
end
end

View file

@ -70,8 +70,10 @@ module Gitlab
end
class Note < Grape::Entity
expose :id
expose :note, as: :body
expose :author, using: Entities::UserBasic
expose :note
expose :updated_at, :created_at
end
end
end

38
lib/api/notes.rb Normal file
View file

@ -0,0 +1,38 @@
module Gitlab
# Notes API
class Notes < Grape::API
before { authenticate! }
NOTEABLE_TYPES = [Issue, Snippet]
resource :projects do
# Get a list of project wall notes
#
# Parameters:
# id (required) - The ID or code name of a project
# Example Request:
# GET /projects/:id/notes
get ":id/notes" do
@notes = user_project.common_notes
present paginate(@notes), with: Entities::Note
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 or code name of a project
# noteable_id (required) - The ID of an issue or snippet
# Example Request:
# GET /projects/:id/noteable/: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
end
end
end
end