diff options
| author | Rémy Coutable <remy@rymai.me> | 2016-10-20 10:10:00 +0000 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2016-10-20 17:16:19 +0200 |
| commit | 0e1a948223f60776d796a65e3a59c98f08d6da7b (patch) | |
| tree | 59fd0ba4983fb2d14e8586351ab62ac0fba54868 | |
| parent | 8026e0163c82ac919d2f962088252ac628a40608 (diff) | |
| download | gitlab-ce-0e1a948223f60776d796a65e3a59c98f08d6da7b.tar.gz | |
Merge branch '23555-project-api-doc' into 'master'
Resolve "Breaking a parameter table in Projects API doc"
## What does this MR do?
- A broken markdown in `Search for projects by name` is fixed.
- cf. !6681
- Pagination is removed from `Search for projects by name` like other docs as it is shown in [/api/README.html](https://docs.gitlab.com/ce/api/README.html)
## Moving docs to a new location?
No.
## What are the relevant issue numbers?
Closes #23555
See merge request !7007
| -rw-r--r-- | CHANGELOG.md | 1 | ||||
| -rw-r--r-- | doc/api/projects.md | 6 |
2 files changed, 3 insertions, 4 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f6378dbb41..552f41272d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -134,6 +134,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..b69db90e70d 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -1333,8 +1333,6 @@ 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 | +| `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 | |