issues.rb 9.39 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
module API
  module V3
    class Issues < Grape::API
      include PaginationParams

      before { authenticate! }

      helpers do
        def find_issues(args = {})
          args = params.merge(args)
11
          args = convert_parameters_from_legacy_format(args)
12 13 14 15 16 17 18 19

          args.delete(:id)
          args[:milestone_title] = args.delete(:milestone)

          match_all_labels = args.delete(:match_all_labels)
          labels = args.delete(:labels)
          args[:label_name] = labels if match_all_labels

20 21
          # IssuesFinder expects iids
          args[:iids] = args.delete(:iid) if args.key?(:iid)
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

          issues = IssuesFinder.new(current_user, args).execute.inc_notes_with_associations

          if !match_all_labels && labels.present?
            issues = issues.includes(:labels).where('labels.title' => labels.split(','))
          end

          issues.reorder(args[:order_by] => args[:sort])
        end

        params :issues_params do
          optional :labels, type: String, desc: 'Comma-separated list of label names'
          optional :milestone, type: String, desc: 'Milestone title'
          optional :order_by, type: String, values: %w[created_at updated_at], default: 'created_at',
                              desc: 'Return issues ordered by `created_at` or `updated_at` fields.'
          optional :sort, type: String, values: %w[asc desc], default: 'desc',
                          desc: 'Return issues sorted in `asc` or `desc` order.'
          optional :milestone, type: String, desc: 'Return issues for a specific milestone'
          use :pagination
        end

        params :issue_params do
          optional :description, type: String, desc: 'The description of an issue'
          optional :assignee_id, type: Integer, desc: 'The ID of a user to assign issue'
          optional :milestone_id, type: Integer, desc: 'The ID of a milestone to assign issue'
          optional :labels, type: String, desc: 'Comma-separated list of label names'
          optional :due_date, type: String, desc: 'Date time string in the format YEAR-MONTH-DAY'
          optional :confidential, type: Boolean, desc: 'Boolean parameter if the issue should be confidential'
        end
      end

      resource :issues do
        desc "Get currently authenticated user's issues" do
55
          success ::API::V3::Entities::Issue
56 57 58 59 60 61 62 63 64
        end
        params do
          optional :state, type: String, values: %w[opened closed all], default: 'all',
                           desc: 'Return opened, closed, or all issues'
          use :issues_params
        end
        get do
          issues = find_issues(scope: 'authored')

65
          present paginate(issues), with: ::API::V3::Entities::Issue, current_user: current_user
66 67 68 69 70 71
        end
      end

      params do
        requires :id, type: String, desc: 'The ID of a group'
      end
72
      resource :groups, requirements: { id: %r{[^/]+} } do
73
        desc 'Get a list of group issues' do
74
          success ::API::V3::Entities::Issue
75 76
        end
        params do
77
          optional :state, type: String, values: %w[opened closed all], default: 'all',
78 79 80 81 82 83
                           desc: 'Return opened, closed, or all issues'
          use :issues_params
        end
        get ":id/issues" do
          group = find_group!(params[:id])

84
          issues = find_issues(group_id: group.id, match_all_labels: true)
85

86
          present paginate(issues), with: ::API::V3::Entities::Issue, current_user: current_user
87 88 89 90 91 92
        end
      end

      params do
        requires :id, type: String, desc: 'The ID of a project'
      end
93
      resource :projects, requirements: { id: %r{[^/]+} } do
94 95 96 97
        include TimeTrackingEndpoints

        desc 'Get a list of project issues' do
          detail 'iid filter is deprecated have been removed on V4'
98
          success ::API::V3::Entities::Issue
99 100 101 102 103 104 105 106
        end
        params do
          optional :state, type: String, values: %w[opened closed all], default: 'all',
                           desc: 'Return opened, closed, or all issues'
          optional :iid, type: Integer, desc: 'Return the issue having the given `iid`'
          use :issues_params
        end
        get ":id/issues" do
107
          project = find_project!(params[:id])
108 109 110

          issues = find_issues(project_id: project.id)

111
          present paginate(issues), with: ::API::V3::Entities::Issue, current_user: current_user, project: user_project
112 113 114
        end

        desc 'Get a single project issue' do
115
          success ::API::V3::Entities::Issue
116 117 118 119 120 121
        end
        params do
          requires :issue_id, type: Integer, desc: 'The ID of a project issue'
        end
        get ":id/issues/:issue_id" do
          issue = find_project_issue(params[:issue_id])
122
          present issue, with: ::API::V3::Entities::Issue, current_user: current_user, project: user_project
123 124 125
        end

        desc 'Create a new project issue' do
126
          success ::API::V3::Entities::Issue
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
        end
        params do
          requires :title, type: String, desc: 'The title of an issue'
          optional :created_at, type: DateTime,
                                desc: 'Date time when the issue was created. Available only for admins and project owners.'
          optional :merge_request_for_resolving_discussions, type: Integer,
                                                             desc: 'The IID of a merge request for which to resolve discussions'
          use :issue_params
        end
        post ':id/issues' do
          # Setting created_at time only allowed for admins and project owners
          unless current_user.admin? || user_project.owner == current_user
            params.delete(:created_at)
          end

          issue_params = declared_params(include_missing: false)
143
          issue_params = issue_params.merge(merge_request_to_resolve_discussions_of: issue_params.delete(:merge_request_for_resolving_discussions))
144
          issue_params = convert_parameters_from_legacy_format(issue_params)
145 146 147 148

          issue = ::Issues::CreateService.new(user_project,
                                              current_user,
                                              issue_params.merge(request: request, api: true)).execute
149
          render_spam_error! if issue.spam?
150 151

          if issue.valid?
152
            present issue, with: ::API::V3::Entities::Issue, current_user: current_user, project: user_project
153 154 155 156 157 158
          else
            render_validation_error!(issue)
          end
        end

        desc 'Update an existing issue' do
159
          success ::API::V3::Entities::Issue
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
        end
        params do
          requires :issue_id, type: Integer, desc: 'The ID of a project issue'
          optional :title, type: String, desc: 'The title of an issue'
          optional :updated_at, type: DateTime,
                                desc: 'Date time when the issue was updated. Available only for admins and project owners.'
          optional :state_event, type: String, values: %w[reopen close], desc: 'State of the issue'
          use :issue_params
          at_least_one_of :title, :description, :assignee_id, :milestone_id,
                          :labels, :created_at, :due_date, :confidential, :state_event
        end
        put ':id/issues/:issue_id' do
          issue = user_project.issues.find(params.delete(:issue_id))
          authorize! :update_issue, issue

          # Setting created_at time only allowed for admins and project owners
          unless current_user.admin? || user_project.owner == current_user
            params.delete(:updated_at)
          end

180
          update_params = declared_params(include_missing: false).merge(request: request, api: true)
181
          update_params = convert_parameters_from_legacy_format(update_params)
182

183 184
          issue = ::Issues::UpdateService.new(user_project,
                                              current_user,
185 186 187
                                              update_params).execute(issue)

          render_spam_error! if issue.spam?
188 189

          if issue.valid?
190
            present issue, with: ::API::V3::Entities::Issue, current_user: current_user, project: user_project
191 192 193 194 195 196
          else
            render_validation_error!(issue)
          end
        end

        desc 'Move an existing issue' do
197
          success ::API::V3::Entities::Issue
198 199 200 201 202 203 204 205 206 207 208 209 210 211
        end
        params do
          requires :issue_id, type: Integer, desc: 'The ID of a project issue'
          requires :to_project_id, type: Integer, desc: 'The ID of the new project'
        end
        post ':id/issues/:issue_id/move' do
          issue = user_project.issues.find_by(id: params[:issue_id])
          not_found!('Issue') unless issue

          new_project = Project.find_by(id: params[:to_project_id])
          not_found!('Project') unless new_project

          begin
            issue = ::Issues::MoveService.new(user_project, current_user).execute(issue, new_project)
212
            present issue, with: ::API::V3::Entities::Issue, current_user: current_user, project: user_project
213 214 215 216 217 218 219 220 221 222 223 224 225 226
          rescue ::Issues::MoveService::MoveError => error
            render_api_error!(error.message, 400)
          end
        end

        desc 'Delete a project issue'
        params do
          requires :issue_id, type: Integer, desc: 'The ID of a project issue'
        end
        delete ":id/issues/:issue_id" do
          issue = user_project.issues.find_by(id: params[:issue_id])
          not_found!('Issue') unless issue

          authorize!(:destroy_issue, issue)
Robert Schilling's avatar
Robert Schilling committed
227 228

          status(200)
229 230 231 232 233 234
          issue.destroy
        end
      end
    end
  end
end