diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2016-12-13 13:51:30 +0100 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2016-12-13 13:54:36 +0100 |
| commit | 7841be243e5f28828cea95500b554d7f5cc039eb (patch) | |
| tree | f9c4dcc6f5015323f65025dcfe693a8e52ca0f3f /doc/api/groups.md | |
| parent | 9a3c53fd4e79b73e51c8aadeb8a996db65088811 (diff) | |
| download | gitlab-ce-7841be243e5f28828cea95500b554d7f5cc039eb.tar.gz | |
API: Ability to get group's project in simple representationapi-simple-group-project
Diffstat (limited to 'doc/api/groups.md')
| -rw-r--r-- | doc/api/groups.md | 17 |
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 [ |