Module: Gitlab::Client::EpicIssues

Included in:

Gitlab::Client

Defined in:

lib/gitlab/client/epic_issues.rb

Overview

Defines methods related to issues.

See Also:

• https://docs.gitlab.com/ee/api/epic_issues.html

Instance Method Summary

• #epic_issues(group, epic, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

  List issues for an epic.

Instance Method Details

#epic_issues(group, epic, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

List issues for an epic. Gets all issues that are assigned to an epic and the authenticated user has access to..

Examples:

Gitlab.epic_issues(5, 7)
Gitlab.epic_issues(5, 7, { per_page: 40 })

Parameters:

• group (Integer, String) —

  The ID or name of a group.

• epic (Integer) —

  The iid of an epic.

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Options Hash (options):

• :page (Integer) —

  The page number.

• :per_page (Integer) —

  The number of results per page.

Returns:

• (Array<Gitlab::ObjectifiedHash>)

# File 'lib/gitlab/client/epic_issues.rb', line 19

def epic_issues(group, epic, options = {})
  get("/groups/#{url_encode group}/epics/#{epic}/issues", query: options)
end