Module: Gitlab::Client::GroupMilestones

Included in:
Gitlab::Client
Defined in:
lib/gitlab/client/group_milestones.rb

Overview

Defines methods related to group milestones.

See Also:

Instance Method Summary collapse

Instance Method Details

#create_group_milestone(id, title, options = {}) ⇒ Gitlab::ObjectifiedHash

Creates a new group milestone.

Examples:

Gitlab.create_group_milestone(5, 'v1.0')

Parameters:

  • The ID or name of a group.

  • The title of a milestone.

  • (defaults to: {})

    A customizable set of options.

Options Hash (options):

  • :description (String) —

    The description of a milestone.

  • :due_date (String) —

    The due date of a milestone.

Returns:

  • Information about created milestone.



42
43
44
45
 
# File 'lib/gitlab/client/group_milestones.rb', line 42

def create_group_milestone(id, title, options={})
  body = { title: title }.merge(options)
  post("/groups/#{url_encode id}/milestones", body: body)
end

#edit_group_milestone(id, milestone_id, options = {}) ⇒ Gitlab::ObjectifiedHash

Updates a group milestone.

Examples:

Gitlab.edit_group_milestone(5, 2, { state_event: 'activate' })

Parameters:

  • The ID or name of a group.

  • The ID of a milestone.

  • (defaults to: {})

    A customizable set of options.

Options Hash (options):

  • :title (String) —

    The title of a milestone.

  • :description (String) —

    The description of a milestone.

  • :due_date (String) —

    The due date of a milestone.

  • :state_event (String) —

    The state of a milestone (‘close’ or ‘activate’).

Returns:

  • Information about updated milestone.



60
61
62
 
# File 'lib/gitlab/client/group_milestones.rb', line 60

def edit_group_milestone(id, milestone_id, options={})
  put("/groups/#{url_encode id}/milestones/#{milestone_id}", body: options)
end

#group_milestone(id, milestone_id) ⇒ Gitlab::ObjectifiedHash

Gets a single group milestone.

Examples:

Gitlab.group_milestone(5, 36)

Parameters:

  • The ID or name of a group.

  • The ID of a milestone.

Returns:



27
28
29
 
# File 'lib/gitlab/client/group_milestones.rb', line 27

def group_milestone(id, milestone_id)
  get("/groups/#{url_encode id}/milestones/#{milestone_id}")
end

#group_milestone_issues(id, milestone_id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Gets the issues of a given group milestone.

Examples:

Gitlab.group_milestone_issues(5, 2)

Parameters:

  • The ID or name of a group.

  • The ID of a milestone.

  • (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:



74
75
76
 
# File 'lib/gitlab/client/group_milestones.rb', line 74

def group_milestone_issues(id, milestone_id, options={})
  get("/groups/#{url_encode id}/milestones/#{milestone_id}/issues", query: options)
end

#group_milestone_merge_requests(id, milestone_id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Gets the merge_requests of a given group milestone.

Examples:

Gitlab.group_milestone_merge_requests(5, 2)

Parameters:

  • The ID or name of a group.

  • The ID of a milestone.

  • (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:



88
89
90
 
# File 'lib/gitlab/client/group_milestones.rb', line 88

def group_milestone_merge_requests(id, milestone_id, options={})
  get("/groups/#{url_encode id}/milestones/#{milestone_id}/merge_requests", query: options)
end

#group_milestones(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Gets a list of a group’s milestones.

Examples:

Gitlab.group_milestones(5)

Parameters:

  • The ID or name of a group.

  • (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:



15
16
17
 
# File 'lib/gitlab/client/group_milestones.rb', line 15

def group_milestones(id, options={})
  get("/groups/#{url_encode id}/milestones", query: options)
end