Skip to content

G
gitlab-ce
Commit 57d3b1de authored by Niklas's avatar Niklas Committed by Achilleas Pipinellis
Browse files
Options

Add missing tiers to api/groups endpoints

parent 122dce2a
Hide whitespace changes
Inline Side-by-side
Showing with 18 additions and 18 deletions
doc/api/group_activity_analytics.md
View file @ 57d3b1de
...@@ -4,7 +4,7 @@ group: Optimize ...@@ -4,7 +4,7 @@ group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
--- ---
# Group Activity Analytics API # Group Activity Analytics API **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26460) in GitLab 12.9. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26460) in GitLab 12.9.
......
doc/api/group_badges.md
View file @ 57d3b1de
...@@ -4,7 +4,7 @@ group: Access ...@@ -4,7 +4,7 @@ group: Access
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
--- ---
# Group badges API # Group badges API **(FREE)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17082) in GitLab 10.6. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17082) in GitLab 10.6.
......
doc/api/group_boards.md
View file @ 57d3b1de
...@@ -76,7 +76,7 @@ Example response: ...@@ -76,7 +76,7 @@ Example response:
] ]
``` ```
Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) see Users on [GitLab Premium or higher](https://about.gitlab.com/pricing/) see
different parameters, due to the ability to have multiple group boards. different parameters, due to the ability to have multiple group boards.
Example response: Example response:
...@@ -192,7 +192,7 @@ Example response: ...@@ -192,7 +192,7 @@ Example response:
} }
``` ```
Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) see Users on [GitLab Premium or higher](https://about.gitlab.com/pricing/) see
different parameters, due to the ability to have multiple group issue boards. different parameters, due to the ability to have multiple group issue boards.
Example response: Example response:
......
doc/api/group_import_export.md
View file @ 57d3b1de
...@@ -4,7 +4,7 @@ group: Import ...@@ -4,7 +4,7 @@ group: Import
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
--- ---
# Group Import/Export API # Group Import/Export API **(FREE)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20353) in GitLab 12.8. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20353) in GitLab 12.8.
......
doc/api/group_labels.md
View file @ 57d3b1de
...@@ -13,7 +13,7 @@ It allows users to list, create, update, and delete group labels. Furthermore, u ...@@ -13,7 +13,7 @@ It allows users to list, create, update, and delete group labels. Furthermore, u
unsubscribe from group labels. unsubscribe from group labels.
NOTE: NOTE:
The `description_html` - was added to response JSON in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413). The `description_html` - was [added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) to response JSON in GitLab 12.7.
## List group labels ## List group labels
...@@ -26,7 +26,7 @@ GET /groups/:id/labels ...@@ -26,7 +26,7 @@ GET /groups/:id/labels
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user. | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user. |
| `with_counts` | boolean | no | Whether or not to include issue and merge request counts. Defaults to `false`. _([Introduced in GitLab 12.2](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31543))_ | | `with_counts` | boolean | no | Whether or not to include issue and merge request counts. Defaults to `false`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31543) in GitLab 12.2)_ |
| `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. |
| `include_descendant_groups` | boolean | no | Include descendant groups. Defaults to `false`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259024) in GitLab 13.6 | | `include_descendant_groups` | boolean | no | Include descendant groups. Defaults to `false`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259024) in GitLab 13.6 |
| `only_group_labels` | boolean | no | Toggle to include only group labels or also project labels. Defaults to `true`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259024) in GitLab 13.6 | | `only_group_labels` | boolean | no | Toggle to include only group labels or also project labels. Defaults to `true`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259024) in GitLab 13.6 |
......
doc/api/group_level_variables.md
View file @ 57d3b1de
...@@ -4,7 +4,7 @@ group: Pipeline Authoring ...@@ -4,7 +4,7 @@ group: Pipeline Authoring
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
--- ---
# Group-level Variables API # Group-level Variables API **(FREE)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/34519) in GitLab 9.5 > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/34519) in GitLab 9.5
......
doc/api/group_milestones.md
View file @ 57d3b1de
...@@ -32,7 +32,7 @@ Parameters: ...@@ -32,7 +32,7 @@ Parameters:
| `state` | string | no | Return only `active` or `closed` milestones | | `state` | string | no | Return only `active` or `closed` milestones |
| `title` | string | no | Return only the milestones having the given `title` | | `title` | string | no | Return only the milestones having the given `title` |
| `search` | string | no | Return only milestones with a title or description matching the provided string | | `search` | string | no | Return only milestones with a title or description matching the provided string |
| `include_parent_milestones` | boolean | optional | Include milestones from parent group and its ancestors. Introduced in [GitLab 13.4](https://gitlab.com/gitlab-org/gitlab/-/issues/196066) | | `include_parent_milestones` | boolean | optional | Include milestones from parent group and its ancestors. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196066) in GitLab 13.4 |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/milestones" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/milestones"
......
doc/api/group_relations_export.md
View file @ 57d3b1de
...@@ -4,7 +4,7 @@ group: Import ...@@ -4,7 +4,7 @@ group: Import
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
--- ---
# Group Relations Export API # Group Relations Export API **(FREE)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/59978) in GitLab 13.12. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/59978) in GitLab 13.12.
......
doc/api/group_wikis.md
View file @ 57d3b1de
...@@ -7,7 +7,7 @@ type: reference, api ...@@ -7,7 +7,7 @@ type: reference, api
# Group wikis API **(PREMIUM)** # Group wikis API **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212199) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212199) in GitLab 13.5.
The [group wikis](../user/project/wiki/index.md#group-wikis) API is available only in APIv4. The [group wikis](../user/project/wiki/index.md#group-wikis) API is available only in APIv4.
An API for [project wikis](wikis.md) is also available. An API for [project wikis](wikis.md) is also available.
......
doc/api/groups.md
View file @ 57d3b1de
...@@ -4,7 +4,7 @@ group: Access ...@@ -4,7 +4,7 @@ group: Access
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
--- ---
# Groups API # Groups API **(FREE)**
## List groups ## List groups
...@@ -769,6 +769,10 @@ For GitLab 14.0 and later, the [limit cannot be disabled](https://gitlab.com/git ...@@ -769,6 +769,10 @@ For GitLab 14.0 and later, the [limit cannot be disabled](https://gitlab.com/git
## New group ## New group
NOTE:
On GitLab SaaS, you must use the GitLab UI to create groups without a parent group. You cannot
use the API to do this.
Creates a new project group. Available only for users who can create groups. Creates a new project group. Available only for users who can create groups.
```plaintext ```plaintext
...@@ -800,10 +804,6 @@ Parameters: ...@@ -800,10 +804,6 @@ Parameters:
| `shared_runners_minutes_limit` | integer | no | **(PREMIUM SELF)** Pipeline minutes quota for this group (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` | | `shared_runners_minutes_limit` | integer | no | **(PREMIUM SELF)** Pipeline minutes quota for this group (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` |
| `extra_shared_runners_minutes_limit` | integer | no | **(PREMIUM SELF)** Extra pipeline minutes quota for this group (purchased in addition to the minutes included in the plan). | | `extra_shared_runners_minutes_limit` | integer | no | **(PREMIUM SELF)** Extra pipeline minutes quota for this group (purchased in addition to the minutes included in the plan). |
NOTE:
On GitLab SaaS, you must use the GitLab UI to create groups without a parent group. You cannot
use the API to do this.
### Options for `default_branch_protection` ### Options for `default_branch_protection`
The `default_branch_protection` attribute determines whether developers and maintainers can push to the applicable [default branch](../user/project/repository/branches/default.md), as described in the following table: The `default_branch_protection` attribute determines whether developers and maintainers can push to the applicable [default branch](../user/project/repository/branches/default.md), as described in the following table:
...@@ -1343,7 +1343,7 @@ DELETE /groups/:id/share/:group_id ...@@ -1343,7 +1343,7 @@ DELETE /groups/:id/share/:group_id
## Push Rules **(PREMIUM)** ## Push Rules **(PREMIUM)**
> Introduced in [GitLab](https://about.gitlab.com/pricing/) 13.4. > Introduced in GitLab 13.4.
### Get group push rules **(PREMIUM)** ### Get group push rules **(PREMIUM)**
...@@ -1375,7 +1375,7 @@ GET /groups/:id/push_rule ...@@ -1375,7 +1375,7 @@ GET /groups/:id/push_rule
} }
``` ```
Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see Users on [GitLab Premium or higher](https://about.gitlab.com/pricing/) also see
the `commit_committer_check` and `reject_unsigned_commits` parameters: the `commit_committer_check` and `reject_unsigned_commits` parameters:
```json ```json
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7