diff options
| author | Marcel Amirault <mamirault@gitlab.com> | 2019-07-05 01:46:12 +0300 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-07-05 01:46:12 +0300 |
| commit | e108f0d9610d0e019791920bb5adbc0b493d7b74 (patch) | |
| tree | b6446ed35724e25b5e0f19fd3efc6ad064c6b9a7 /doc/api/milestones.md | |
| parent | 546ee64c4764ac9cf27aa3d0e46fac51a4eb9bff (diff) | |
Small markdown tweaks to clear kramdown warnings
Fixing square brackets, links, etc in:
merge_requests.md
vulnerabilities.md
issues.md
issues_statistics.md
pipelines.md
services.md
group_milestones.md
milestones.md
runners.md
changelog.md
issue_workflow.md
elasticsearch.md
api_graphql_styleguide.md
automatic_ce_ee_merge.md
file_storage.md
architecture.md
database_debugging.md
index.md
index.md
frontend_testing.md
pry_debugging.md
vue.md
development_process.md
Diffstat (limited to 'doc/api/milestones.md')
| -rw-r--r-- | doc/api/milestones.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/milestones.md b/doc/api/milestones.md index e745d0c2e6c..8f69378dac3 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -16,13 +16,13 @@ GET /projects/:id/milestones?search=version Parameters: -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `iids[]` | Array[integer] | 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 | +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](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 | ```bash curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/milestones |