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 10:10:00 +0000 |
| commit | ba28a64ef93f44e45e6ec04a15f6170061f309e1 (patch) | |
| tree | e7228abe6030b59453d9d2f53ae17f04c385af40 | |
| parent | 1f949c0a6b08563f3abcd9fd4c9e750c4097b44b (diff) | |
| parent | a8bbe53c0c15c0924bce971e1ed853630d2b6d56 (diff) | |
| download | gitlab-ce-ba28a64ef93f44e45e6ec04a15f6170061f309e1.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 dfde2cc81e5..399a7f65267 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -135,6 +135,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 | |