summaryrefslogtreecommitdiff
path: root/doc/api/groups.md
diff options
context:
space:
mode:
authorRegis <boudinot.regis@yahoo.com>2016-12-13 13:03:49 -0700
committerRegis <boudinot.regis@yahoo.com>2016-12-13 13:03:49 -0700
commit77daed05ca877e9882096787b3d57244baaa5d91 (patch)
tree48e972448234b338dba2fce10eaee19f8e6027ec /doc/api/groups.md
parentd46af1d9b263916063200f5fd2cafa18df11c37b (diff)
parent632450a4bd95c7f67f9968e57b317dc4b4704f5f (diff)
downloadgitlab-ce-77daed05ca877e9882096787b3d57244baaa5d91.tar.gz
merge master
Diffstat (limited to 'doc/api/groups.md')
-rw-r--r--doc/api/groups.md17
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md
index 5e6f498c365..134d7bda22f 100644
--- a/doc/api/groups.md
+++ b/doc/api/groups.md
@@ -50,12 +50,17 @@ GET /groups/:id/projects
Parameters:
-- `archived` (optional) - if passed, limit by archived status
-- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
-- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
-- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
-- `search` (optional) - Return list of authorized projects according to a search criteria
-- `ci_enabled_first` - Return projects ordered by ci_enabled flag. Projects with enabled GitLab CI go first
+| Attribute | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+| `id` | integer/string | yes | The ID or path of a group |
+| `archived` | boolean | no | Limit by archived status |
+| `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` |
+| `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` |
+| `sort` | string | no | Return projects sorted in `asc` or `desc` order. Default is `desc` |
+| `search` | string | no | Return list of authorized projects matching the search criteria |
+| `simple` | boolean | no | Return only the ID, URL, name, and path of each project |
+
+Example response:
```json
[