From 9f46488805e86b1bc341ea1620b866016c2ce5ed Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Wed, 20 May 2020 14:34:42 +0000 Subject: Add latest changes from gitlab-org/gitlab@13-0-stable-ee --- doc/api/group_milestones.md | 73 ++++++++++++++++++++++++++------------------- 1 file changed, 43 insertions(+), 30 deletions(-) (limited to 'doc/api/group_milestones.md') diff --git a/doc/api/group_milestones.md b/doc/api/group_milestones.md index 7e2a6987208..10445acf881 100644 --- a/doc/api/group_milestones.md +++ b/doc/api/group_milestones.md @@ -1,6 +1,6 @@ # Group milestones API -> [Introduced][ce-12819] in GitLab 9.5. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12819) in GitLab 9.5. ## List group milestones @@ -21,10 +21,10 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | -| `iids[]` | integer array | optional | Return only the milestones having the given `iid` | -| `state` | string | optional | Return only `active` or `closed` milestones | -| `title` | string | optional | Return only the milestones having the given `title` | -| `search` | string | optional | Return only milestones with a title or description matching the provided string | +| `iids[]` | integer array | no | Return only the milestones having the given `iid` | +| `state` | string | no | Return only `active` or `closed` milestones | +| `title` | string | no | Return only the milestones having the given `title` | +| `search` | string | no | Return only milestones with a title or description matching the provided string | ```shell curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/5/milestones @@ -44,7 +44,8 @@ Example Response: "start_date": "2013-11-10", "state": "active", "updated_at": "2013-10-02T09:24:18Z", - "created_at": "2013-10-02T09:24:18Z" + "created_at": "2013-10-02T09:24:18Z", + "web_url": "https://gitlab.com/groups/gitlab-org/-/milestones/42" } ] ``` @@ -59,8 +60,10 @@ GET /groups/:id/milestones/:milestone_id Parameters: -- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user -- `milestone_id` (required) - The ID of the group milestone +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `milestone_id` | integer | yes | The ID of the group milestone | ## Create new milestone @@ -72,11 +75,13 @@ POST /groups/:id/milestones Parameters: -- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user -- `title` (required) - The title of a milestone -- `description` (optional) - The description of the milestone -- `due_date` (optional) - The due date of the milestone -- `start_date` (optional) - The start date of the milestone +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `title` | string | yes | The title of a milestone | +| `description` | string | no | The description of the milestone | +| `due_date` | date | no | The due date of the milestone, in YYYY-MM-DD format (ISO 8601) | +| `start_date` | date | no | The start date of the milestone, in YYYY-MM-DD format (ISO 8601) | ## Edit milestone @@ -88,13 +93,15 @@ PUT /groups/:id/milestones/:milestone_id Parameters: -- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user -- `milestone_id` (required) - The ID of a group milestone -- `title` (optional) - The title of a milestone -- `description` (optional) - The description of a milestone -- `due_date` (optional) - The due date of the milestone -- `start_date` (optional) - The start date of the milestone -- `state_event` (optional) - The state event of the milestone (close|activate) +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `milestone_id` | integer | yes | The ID of a group milestone | +| `title` | string | no | The title of a milestone | +| `description` | string | no | The description of a milestone | +| `due_date` | date | no | The due date of the milestone, in YYYY-MM-DD format (ISO 8601) | +| `start_date` | date | no | The start date of the milestone, in YYYY-MM-DD format (ISO 8601) | +| `state_event` | string | no | The state event of the milestone _(`close` or `activate`)_ | ## Delete group milestone @@ -106,8 +113,10 @@ DELETE /groups/:id/milestones/:milestone_id Parameters: -- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user -- `milestone_id` (required) - The ID of the group's milestone +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `milestone_id` | integer | yes | The ID of the group's milestone | ## Get all issues assigned to a single milestone @@ -119,8 +128,10 @@ GET /groups/:id/milestones/:milestone_id/issues Parameters: -- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user -- `milestone_id` (required) - The ID of a group milestone +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `milestone_id` | integer | yes | The ID of a group milestone | ## Get all merge requests assigned to a single milestone @@ -132,10 +143,10 @@ GET /groups/:id/milestones/:milestone_id/merge_requests Parameters: -- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user -- `milestone_id` (required) - The ID of a group milestone - -[ce-12819]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12819 +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `milestone_id` | integer | yes | The ID of a group milestone | ## Get all burndown chart events for a single milestone **(STARTER)** @@ -149,5 +160,7 @@ GET /groups/:id/milestones/:milestone_id/burndown_events Parameters: -- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user -- `milestone_id` (required) - The ID of a group milestone +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `milestone_id` | integer | yes | The ID of a group milestone | -- cgit v1.2.3