BigW Consortium Gitlab

notes.rb 4.25 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
        get ":id/#{noteables_str}/:#{noteable_id_str}/notes" do
          @noteable = user_project.send(:"#{noteables_str}").find(params[:"#{noteable_id_str}"])
23 24 25 26 27 28 29 30 31 32 33 34 35

          # 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 =
            # 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.
            paginate(@noteable.notes).
            reject { |n| n.cross_reference_not_visible_for?(current_user) }
          present notes, with: Entities::Note
36
        end
Nihad Abbasov committed
37 38 39 40

        # Get a single +noteable+ note
        #
        # Parameters:
41
        #   id (required) - The ID of a project
Nihad Abbasov committed
42 43 44 45 46 47 48 49
        #   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])
50 51 52 53 54 55

          if @note.cross_reference_not_visible_for?(current_user)
            not_found!("Note")
          else
            present @note, with: Entities::Note
          end
Nihad Abbasov committed
56
        end
Nihad Abbasov committed
57 58 59 60

        # Create a new +noteable+ note
        #
        # Parameters:
61
        #   id (required) - The ID of a project
Nihad Abbasov committed
62 63 64 65 66 67
        #   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
68
          required_attributes! [:body]
69

70 71 72 73 74 75 76
          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
77

78
          if @note.valid?
79 80
            present @note, with: Entities::Note
          else
81
            not_found!("Note #{@note.errors.messages}")
Nihad Abbasov committed
82 83
          end
        end
84 85 86 87 88 89 90 91 92 93 94 95 96 97

        # 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]

98 99 100
          note = user_project.notes.find(params[:note_id])

          authorize! :admin_note, note
101 102

          opts = {
103
            note: params[:body]
104 105
          }

106
          @note = ::Notes::UpdateService.new(user_project, current_user, opts).execute(note)
107 108 109 110

          if @note.valid?
            present @note, with: Entities::Note
          else
111
            render_api_error!("Failed to save note #{note.errors.messages}", 400)
112 113 114
          end
        end

115 116 117 118
      end
    end
  end
end