Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2019-12-07 21:07:50 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2019-12-07 21:07:50 +0300
commitec169c6384b44291551eb7998b4f7f1102a8af07 (patch)
treedb35206559e536f354e53d71365054062f43b7fc /doc/api/groups.md
parentf3597fc9f048f07e717ac4cb743a083b219f6258 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/groups.md')
-rw-r--r--doc/api/groups.md48
1 files changed, 46 insertions, 2 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md
index 94f46b11a0f..32e2a88f25b 100644
--- a/doc/api/groups.md
+++ b/doc/api/groups.md
@@ -5,6 +5,8 @@
Get a list of visible groups for the authenticated user. When accessed without
authentication, only public groups are returned.
+By default, this request returns 20 results at a time because the API results [are paginated](README.md#pagination).
+
Parameters:
| Attribute | Type | Required | Description |
@@ -106,6 +108,8 @@ GET /groups?custom_attributes[key]=value&custom_attributes[other_key]=other_valu
Get a list of visible direct subgroups in this group.
When accessed without authentication, only public groups are returned.
+By default, this request returns 20 results at a time because the API results [are paginated](README.md#pagination).
+
Parameters:
| Attribute | Type | Required | Description |
@@ -154,8 +158,9 @@ GET /groups/:id/subgroups
## List a group's projects
-Get a list of projects in this group. When accessed without authentication, only
-public projects are returned.
+Get a list of projects in this group. When accessed without authentication, only public projects are returned.
+
+By default, this request returns 20 results at a time because the API results [are paginated](README.md#pagination).
```
GET /groups/:id/projects
@@ -247,6 +252,13 @@ Parameters:
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4
```
+This endpoint returns:
+
+- All projects and shared projects in GitLab 12.5 and earlier.
+- A maximum of 100 projects and shared projects [in GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/issues/31031)
+ and later. To get the details of all projects within a group, use the
+ [list a group's projects endpoint](#list-a-groups-projects) instead.
+
Example response:
```json
@@ -439,6 +451,18 @@ Example response:
}
```
+### Disabling the results limit
+
+The 100 results limit can be disabled if it breaks integrations developed using GitLab
+12.4 and earlier.
+
+To disable the limit while migrating to using the [list a group's projects](#list-a-groups-projects) endpoint, ask a GitLab administrator
+with Rails console access to run the following command:
+
+```ruby
+Feature.disable(:limit_projects_in_groups_api)
+```
+
## New group
Creates a new project group. Available only for users who can create groups.
@@ -518,6 +542,13 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab
```
+This endpoint returns:
+
+- All projects and shared projects in GitLab 12.5 and earlier.
+- A maximum of 100 projects and shared projects [in GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/issues/31031)
+ and later. To get the details of all projects within a group, use the
+ [list a group's projects endpoint](#list-a-groups-projects) instead.
+
Example response:
```json
@@ -577,6 +608,19 @@ Example response:
}
```
+### Disabling the results limit
+
+The 100 results limit can be disabled if it breaks integrations developed using GitLab
+12.4 and earlier.
+
+To disable the limit while migrating to using the
+[list a group's projects](#list-a-groups-projects) endpoint, ask a GitLab administrator
+with Rails console access to run the following command:
+
+```ruby
+Feature.disable(:limit_projects_in_groups_api)
+```
+
## Remove group
Removes group with all projects inside. Only available to group owners and administrators.