| Module | Gitlab::Client::Milestones |
| In: |
lib/gitlab/client/milestones.rb
|
Defines methods related to milestones. @see github.com/gitlabhq/gitlabhq/blob/master/doc/api/milestones.md
Creates a new milestone.
@example
Gitlab.create_milestone(5, 'v1.0')
@param [Integer] project The ID of a project. @param [String] title The title of a milestone. @param [Hash] options A customizable set of options. @option options [String] :description The description of a milestone. @option options [String] :due_date The due date of a milestone. @return [Gitlab::ObjectifiedHash] Information about created milestone.
Updates a milestone.
@example
Gitlab.edit_milestone(5, 2, { state_event: 'activate' })
@param [Integer] project The ID of a project. @param [Integer] id The ID of a milestone. @param [Hash] options A customizable set of options. @option options [String] :title The title of a milestone. @option options [String] :description The description of a milestone. @option options [String] :due_date The due date of a milestone. @option options [String] :state_event The state of a milestone (‘close’ or ‘activate’). @return [Gitlab::ObjectifiedHash] Information about updated milestone.
Gets a single milestone.
@example
Gitlab.milestone(5, 36)
@param [Integer, String] project The ID of a project. @param [Integer] id The ID of a milestone. @return [Gitlab::ObjectifiedHash]
Gets the issues of a given milestone.
@example
Gitlab.milestone_issues(5, 2)
@param [Integer, String] project The ID of a project. @param [Integer, String] milestone The ID of a milestone. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]
Gets a list of project‘s milestones.
@example
Gitlab.milestones(5)
@param [Integer] project The ID of a project. @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>]