diff options
| author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2014-12-29 16:10:17 +0000 |
|---|---|---|
| committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2014-12-29 16:10:17 +0000 |
| commit | 71ae8570fcefff809bdd1bc293d6d2d68e83b573 (patch) | |
| tree | edf87eadd9f9d3583770ed8f83f00e415ae7873f /doc/api/projects.md | |
| parent | 75043a9eba557d1fe31d81dc30bd979af321e907 (diff) | |
| parent | 23e83a6a99d1e79c0d81281b2bde5680bbfe5f3d (diff) | |
| download | gitlab-ce-71ae8570fcefff809bdd1bc293d6d2d68e83b573.tar.gz | |
Merge branch 'project-ordering' into 'master'
API: Project ordering
Added support for ordering and sorting projects by id, name, created_at or last_activity_at fields.
When the order_by parameter is passed the projects will be ordered by the appropriate field, when the parameter is not passed the original ordering will apply.
the sort parameter will default to ASC, and will only be DESC if the sort parameter is desc
See merge request !266
Diffstat (limited to 'doc/api/projects.md')
| -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 |