BigW Consortium Gitlab

notes.rb 3.46 KB
Newer Older
1
module API
2 3 4 5
  # Notes API
  class Notes < Grape::API
    before { authenticate! }

6
    NOTEABLE_TYPES = [Issue, MergeRequest, Snippet]
7 8 9 10 11 12 13 14 15

    resource :projects do
      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:
16
        #   id (required) - The ID of a project
17 18
        #   noteable_id (required) - The ID of an issue or snippet
        # Example Request:
Nihad Abbasov committed
19 20
        #   GET /projects/:id/issues/:noteable_id/notes
        #   GET /projects/:id/snippets/:noteable_id/notes
21 22 23 24
        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
Nihad Abbasov committed
25 26 27 28

        # Get a single +noteable+ note
        #
        # Parameters:
29
        #   id (required) - The ID of a project
Nihad Abbasov committed
30 31 32 33 34 35 36 37 38 39
        #   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
Nihad Abbasov committed
40 41 42 43

        # Create a new +noteable+ note
        #
        # Parameters:
44
        #   id (required) - The ID of a project
Nihad Abbasov committed
45 46 47 48 49 50
        #   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
51
          required_attributes! [:body]
52

53 54 55 56 57 58 59
          opts = {
           note: params[:body],
           noteable_type: noteables_str.classify,
           noteable_id: params[noteable_id_str]
          }

          @note = ::Notes::CreateService.new(user_project, current_user, opts).execute
Nihad Abbasov committed
60

61
          if @note.valid?
62 63
            present @note, with: Entities::Note
          else
64
            not_found!("Note #{@note.errors.messages}")
Nihad Abbasov committed
65 66
          end
        end
67 68 69 70 71 72 73 74 75 76 77 78 79 80

        # Modify existing +noteable+ note
        #
        # Parameters:
        #   id (required) - The ID of a project
        #   noteable_id (required) - The ID of an issue or snippet
        #   node_id (required) - The ID of a note
        #   body (required) - New content of a note
        # Example Request:
        #   PUT /projects/:id/issues/:noteable_id/notes/:note_id
        #   PUT /projects/:id/snippets/:noteable_id/notes/:node_id
        put ":id/#{noteables_str}/:#{noteable_id_str}/notes/:note_id" do
          required_attributes! [:body]

81 82 83
          note = user_project.notes.find(params[:note_id])

          authorize! :admin_note, note
84 85

          opts = {
86
            note: params[:body]
87 88
          }

89
          @note = ::Notes::UpdateService.new(user_project, current_user, opts).execute(note)
90 91 92 93

          if @note.valid?
            present @note, with: Entities::Note
          else
94
            render_api_error!("Failed to save note #{note.errors.messages}", 400)
95 96 97
          end
        end

98 99 100 101
      end
    end
  end
end