diff options
author | Takuya Noguchi <tak.noguchi.iridge@gmail.com> | 2016-10-20 08:57:23 +0900 |
---|---|---|
committer | Takuya Noguchi <tak.noguchi.iridge@gmail.com> | 2016-10-20 08:57:23 +0900 |
commit | af8e06ee4c1ca54e7e05a40433d09253ba55fbbb (patch) | |
tree | 9fd3c8a81220722a672bef8f4a31d691a5aa9234 | |
parent | c08435e3c25f0a7a705ed8a49b16dde176b41a40 (diff) | |
download | gitlab-ce-af8e06ee4c1ca54e7e05a40433d09253ba55fbbb.tar.gz |
Fix a broken table in Project API doc
-rw-r--r-- | CHANGELOG.md | 1 | ||||
-rw-r--r-- | doc/api/projects.md | 8 |
2 files changed, 5 insertions, 4 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b018fc0d57..a0e7dff7e1a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -133,6 +133,7 @@ Please view this file on the master branch, on stable branches it's out of date. - Delete dynamic environments - Fix buggy iOS tooltip layering behavior. - Make guests unable to view MRs on private projects + - Fix broken Project API docs (Takuya Noguchi) ## 8.12.7 diff --git a/doc/api/projects.md b/doc/api/projects.md index b7791b4748a..77d6bd6b5c2 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -1333,8 +1333,8 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` (required) - A string contained in the project name -| `per_page` (optional) - number of projects to return per page -| `page` (optional) - the page to retrieve -| `order_by` (optional) - Return requests ordered by `id`, `name`, `created_at` or `last_activity_at` fields +| `query` | string | yes | A string contained in the project name | +| `per_page` | integer | no | number of projects to return per page | +| `page` | integer | no | the page to retrieve | +| `order_by` | string | no | Return requests ordered by `id`, `name`, `created_at` or `last_activity_at` fields | | `sort` | string | no | Return requests sorted in `asc` or `desc` order | |