diff options
| author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2015-01-22 18:31:18 +0000 |
|---|---|---|
| committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2015-01-22 18:31:18 +0000 |
| commit | 02c5077fde9551f282763383864c3a87e227d01a (patch) | |
| tree | 543ff8d94d91022f105721de48f2367f01491617 /doc | |
| parent | 635f62be67a0a0e7cb02df40317e1c58c78738fb (diff) | |
| parent | e03f1af00a513a15085a69374a84a2f2df4689d1 (diff) | |
| download | gitlab-ce-02c5077fde9551f282763383864c3a87e227d01a.tar.gz | |
Merge branch 'feature_api_milestone_issues' into 'master'
API: List issues for a particular milestone
# What does this MR do?
This MR adds a new API method for retrieving the issues associated with a particular milestone. The resource is described at ":id/milestones/:milestone_id/issues", returning a simple array of issues.
I've picked up gitlab-org/gitlab-ce!113 and fixed the test for it.
From the original MR:
This feature was motivated by an in-house project for reporting--for large projects, retrieving and filtering the entire issue list by milestone was becoming too slow, particularly when pagination required multiple requests. While this resource also uses pagination, it allows the consumer to limit reporting to the particular milestone they are interested in.
@dblessing Please take a look :)
See merge request !308
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/milestones.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/api/milestones.md b/doc/api/milestones.md index 2f525327504..d48b3bcce8a 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -72,3 +72,16 @@ Parameters: - `description` (optional) - The description of a milestone - `due_date` (optional) - The due date of the milestone - `state_event` (optional) - The state event of the milestone (close|activate) + +## Get all issues assigned to a single milestone + +Gets all issues assigned to a single project milestone. + +``` +GET /projects/:id/milestones/:milestone_id/issues +``` + +Parameters: + +- `id` (required) - The ID of a project +- `milestone_id` (required) - The ID of a project milestone |