diff options
author | Stephan van Leeuwen <stephan.vanleeuwen5@gmail.com> | 2014-12-19 13:27:27 +0100 |
---|---|---|
committer | Stephan van Leeuwen <stephan.vanleeuwen5@gmail.com> | 2014-12-29 16:36:56 +0100 |
commit | 6b507219465e50ceff726535f92b75fa9567906d (patch) | |
tree | ec46429a213278e3f0a5f6c1ce25f637f74ae8a6 /doc/api | |
parent | 75043a9eba557d1fe31d81dc30bd979af321e907 (diff) | |
download | gitlab-ce-6b507219465e50ceff726535f92b75fa9567906d.tar.gz |
Updated projects api to allow ordering
Added support for order_by and sort parameters, to sort the projects by the specified values.
Updated projects api documentation including the order_by and sort parameters
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/projects.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index 0055e2e476f..22d3c828a4b 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -11,6 +11,8 @@ GET /projects Parameters: - `archived` (optional) - if passed, limit by archived status +- `order_by` (optional) - Return requests ordered by `id`, `name`, `created_at` or `last_activity_at` fields +- `sort` (optional) - Return requests sorted in `asc` or `desc` order ```json [ @@ -628,6 +630,8 @@ GET /projects/search/:query Parameters: -- 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 +- `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 +- `sort` (optional) - Return requests sorted in `asc` or `desc` order |