Skip to content

G
gitlab-ce
Commit 2cb02f2f authored by Matthias's avatar Matthias
Browse files
Options

Updated API docs of group_milestones 

- use tables for displaying parameters
- Display params at "Edit milestone" broken 'cause of using "pipe" char
parent 191b9600
Hide whitespace changes
Inline Side-by-side
Showing with 40 additions and 26 deletions
doc/api/group_milestones.md
View file @ 2cb02f2f
...@@ -21,10 +21,10 @@ Parameters: ...@@ -21,10 +21,10 @@ Parameters:
| Attribute | Type | Required | Description | | 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 | | `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` | | `iids[]` | integer array | no | Return only the milestones having the given `iid` |
| `state` | string | optional | Return only `active` or `closed` milestones | | `state` | string | no | Return only `active` or `closed` milestones |
| `title` | string | optional | Return only the milestones having the given `title` | | `title` | string | no | Return only the milestones having the given `title` |
| `search` | string | optional | Return only milestones with a title or description matching the provided string | | `search` | string | no | Return only milestones with a title or description matching the provided string |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/milestones curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/milestones
...@@ -59,8 +59,10 @@ GET /groups/:id/milestones/:milestone_id ...@@ -59,8 +59,10 @@ GET /groups/:id/milestones/:milestone_id
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `milestone_id` (required) - The ID of the group milestone | --------- | ------ | -------- | ----------- |
| `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 ## Create new milestone
...@@ -72,11 +74,13 @@ POST /groups/:id/milestones ...@@ -72,11 +74,13 @@ POST /groups/:id/milestones
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `title` (required) - The title of a milestone | --------- | ------ | -------- | ----------- |
- `description` (optional) - The description of the milestone | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
- `due_date` (optional) - The due date of the milestone | `title` | string | yes | The title of a milestone |
- `start_date` (optional) - The start date of the milestone | `description` | string | no | The description of the milestone |
| `due_date` | datetime | no | The due date of the milestone |
| `start_date` | datetime | no | The start date of the milestone |
## Edit milestone ## Edit milestone
...@@ -88,13 +92,15 @@ PUT /groups/:id/milestones/:milestone_id ...@@ -88,13 +92,15 @@ PUT /groups/:id/milestones/:milestone_id
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `milestone_id` (required) - The ID of a group milestone | --------- | ------ | -------- | ----------- |
- `title` (optional) - The title of a milestone | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
- `description` (optional) - The description of a milestone | `milestone_id` | integer | yes | The ID of a group milestone |
- `due_date` (optional) - The due date of the milestone | `title` | string | no | The title of a milestone |
- `start_date` (optional) - The start date of the milestone | `description` | string | no | The description of a milestone |
- `state_event` (optional) - The state event of the milestone (close|activate) | `due_date` | datetime | no | The due date of the milestone |
| `start_date` | datetime | no | The start date of the milestone |
| `state_event` | string | no | The state event of the milestone _(`close` or `activate`)_ |
## Delete group milestone ## Delete group milestone
...@@ -106,8 +112,10 @@ DELETE /groups/:id/milestones/:milestone_id ...@@ -106,8 +112,10 @@ DELETE /groups/:id/milestones/:milestone_id
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `milestone_id` (required) - The ID of the group's milestone | --------- | ------ | -------- | ----------- |
| `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 ## Get all issues assigned to a single milestone
...@@ -119,8 +127,10 @@ GET /groups/:id/milestones/:milestone_id/issues ...@@ -119,8 +127,10 @@ GET /groups/:id/milestones/:milestone_id/issues
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `milestone_id` (required) - The ID of a group milestone | --------- | ------ | -------- | ----------- |
| `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 ## Get all merge requests assigned to a single milestone
...@@ -132,8 +142,10 @@ GET /groups/:id/milestones/:milestone_id/merge_requests ...@@ -132,8 +142,10 @@ GET /groups/:id/milestones/:milestone_id/merge_requests
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `milestone_id` (required) - The ID of a group milestone | --------- | ------ | -------- | ----------- |
| `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)** ## Get all burndown chart events for a single milestone **(STARTER)**
...@@ -147,5 +159,7 @@ GET /groups/:id/milestones/:milestone_id/burndown_events ...@@ -147,5 +159,7 @@ GET /groups/:id/milestones/:milestone_id/burndown_events
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | Attribute | Type | Required | Description |
- `milestone_id` (required) - The ID of a group milestone | --------- | ------ | -------- | ----------- |
| `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 |
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7