lib/gitlab/client/epic_issues.rb - ruby-gitlab (c64b1a5)

Tree @c64b1a5 (Download .tar.gz)

..
access_requests.rb
application_settings.rb
avatar.rb
award_emojis.rb
boards.rb
branches.rb
broadcast_messages.rb
build_variables.rb
builds.rb
commits.rb
container_registry.rb
deployments.rb
environments.rb
epic_issues.rb
epics.rb
events.rb
features.rb
group_boards.rb
group_labels.rb
group_milestones.rb
groups.rb
issue_links.rb
issues.rb
jobs.rb
keys.rb
labels.rb
lint.rb
markdown.rb
merge_request_approvals.rb
merge_requests.rb
milestones.rb
namespaces.rb
notes.rb
pipeline_schedules.rb
pipeline_triggers.rb
pipelines.rb
project_badges.rb
project_clusters.rb
project_release_links.rb
project_releases.rb
projects.rb
protected_tags.rb
repositories.rb
repository_files.rb
repository_submodules.rb
resource_label_events.rb
runners.rb
search.rb
services.rb
sidekiq.rb
snippets.rb
system_hooks.rb
tags.rb
templates.rb
todos.rb
user_snippets.rb
users.rb
versions.rb
wikis.rb

epic_issues.rb @c64b1a5 — raw · history · blame

# 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