File: epic_issues.rb

package info (click to toggle)
ruby-gitlab 6.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,824 kB
  • sloc: ruby: 12,742; makefile: 7; sh: 4; javascript: 3
file content (23 lines) | stat: -rw-r--r-- 891 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# frozen_string_literal: true

class Gitlab::Client
  # Defines methods related to issues.
  # @see https://docs.gitlab.com/ee/api/epic_issues.html
  module EpicIssues
    # List issues for an epic.
    # Gets all issues that are assigned to an epic and the authenticated user has access to..
    # @example
    #   Gitlab.epic_issues(5, 7)
    #   Gitlab.epic_issues(5, 7, { per_page: 40 })
    #
    # @param  [Integer, String] group The ID or name of a group.
    # @param  [Integer] epic The iid of an epic.
    # @param  [Hash] options A customizable set of options.
    # @option options [Integer] :page The page number.
    # @option options [Integer] :per_page The number of results per page.
    # @return [Array<Gitlab::ObjectifiedHash>]
    def epic_issues(group, epic, options = {})
      get("/groups/#{url_encode group}/epics/#{epic}/issues", query: options)
    end
  end
end