From 3591ecba91126089ebf916f9bd95fe497609920c Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Wed, 10 May 2023 03:09:12 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/api/deployments.md | 8 ++++---- doc/api/epic_issues.md | 2 +- doc/api/feature_flag_user_lists.md | 2 +- doc/api/groups.md | 2 +- doc/api/projects.md | 24 ++++++++++++------------ doc/api/rest/index.md | 4 ++-- doc/api/templates/dockerfiles.md | 2 +- 7 files changed, 22 insertions(+), 22 deletions(-) (limited to 'doc/api') diff --git a/doc/api/deployments.md b/doc/api/deployments.md index 9cd5381da23..cbcf06e1a11 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -279,7 +279,7 @@ Example response: } ``` -When the [unified approval setting](../ci/environments/deployment_approvals.md#unified-approval-setting) is configured, deployments created by users on GitLab Premium or higher include the `approvals` and `pending_approval_count` properties: +When the [unified approval setting](../ci/environments/deployment_approvals.md#unified-approval-setting) is configured, deployments created by users on GitLab Premium or Ultimate include the `approvals` and `pending_approval_count` properties: ```json { @@ -304,7 +304,7 @@ When the [unified approval setting](../ci/environments/deployment_approvals.md#u } ``` -When the [multiple approval rules](../ci/environments/deployment_approvals.md#multiple-approval-rules) is configured, deployments created by users on GitLab Premium or higher include the `approval_summary` property: +When the [multiple approval rules](../ci/environments/deployment_approvals.md#multiple-approval-rules) is configured, deployments created by users on GitLab Premium or Ultimate include the `approval_summary` property: ```json { @@ -393,7 +393,7 @@ Example response: } ``` -Deployments created by users on GitLab Premium or higher include the `approvals` and `pending_approval_count` properties: +Deployments created by users on GitLab Premium or Ultimate include the `approvals` and `pending_approval_count` properties: ```json { @@ -447,7 +447,7 @@ Example response: } ``` -Deployments created by users on GitLab Premium or higher include the `approvals` and `pending_approval_count` properties: +Deployments created by users on GitLab Premium or Ultimate include the `approvals` and `pending_approval_count` properties: ```json { diff --git a/doc/api/epic_issues.md b/doc/api/epic_issues.md index 9d3a32beb07..506d6d4b339 100644 --- a/doc/api/epic_issues.md +++ b/doc/api/epic_issues.md @@ -11,7 +11,7 @@ Every API call to the epic issues API endpoint must be authenticated. If a user is not a member of a group and the group is private, a `GET` request on that group results in a `404` status code. -Epics are available only in GitLab [Premium and higher](https://about.gitlab.com/pricing/). +Epics are available only in GitLab [Premium and Ultimate](https://about.gitlab.com/pricing/). If the Epics feature is not available, a `403` status code is returned. ## Epic Issues pagination diff --git a/doc/api/feature_flag_user_lists.md b/doc/api/feature_flag_user_lists.md index ee8ec3f9595..0152ec62c7f 100644 --- a/doc/api/feature_flag_user_lists.md +++ b/doc/api/feature_flag_user_lists.md @@ -11,7 +11,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w API for accessing GitLab feature flag user lists. -Users with Developer or higher [permissions](../user/permissions.md) can access the feature flag user lists API. +Users with at least the Developer [role](../user/permissions.md) can access the feature flag user lists API. NOTE: `GET` requests return twenty results at a time because the API results diff --git a/doc/api/groups.md b/doc/api/groups.md index 25daf473bd1..6d295b50a01 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -1136,7 +1136,7 @@ Only available to group owners and administrators. This endpoint: -- On Premium and higher tiers, marks the group for deletion. The deletion happens 7 days later by default, but you can change the retention period in the [instance settings](../user/admin_area/settings/visibility_and_access_controls.md#deletion-protection). +- On Premium and Ultimate tiers, marks the group for deletion. The deletion happens 7 days later by default, but you can change the retention period in the [instance settings](../user/admin_area/settings/visibility_and_access_controls.md#deletion-protection). - On Free tier, removes the group immediately and queues a background job to delete all projects in the group. - Deletes a subgroup immediately if the subgroup is marked for deletion (GitLab 15.4 and later). The endpoint does not immediately delete top-level groups. diff --git a/doc/api/projects.md b/doc/api/projects.md index 414cacb70ec..ca57ca76a81 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -60,7 +60,7 @@ GET /projects | `simple` | boolean | **{dotted-circle}** No | Return only limited fields for each project. This operation is a no-op without authentication where only simple fields are returned. | | `sort` | string | **{dotted-circle}** No | Return projects sorted in `asc` or `desc` order. Default is `desc`. | | `starred` | boolean | **{dotted-circle}** No | Limit by projects starred by the current user. | -| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Only available to Reporter or higher level role members. | +| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Available only to users with at least the Reporter role. | | `topic` | string | **{dotted-circle}** No | Comma-separated topic names. Limit results to projects that match all of given topics. See `topics` attribute. | | `topic_id` | integer | **{dotted-circle}** No | Limit results to projects with the assigned topic given by the topic ID. | | `visibility` | string | **{dotted-circle}** No | Limit by visibility `public`, `internal`, or `private`. | @@ -271,11 +271,11 @@ The `tag_list` attribute has been deprecated and is removed in API v5 in favor of the `topics` attribute. NOTE: -For users of [GitLab Premium or higher](https://about.gitlab.com/pricing/), +For users of [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/), the `marked_for_deletion_at` attribute has been deprecated, and is removed in API v5 in favor of the `marked_for_deletion_on` attribute. -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) +Users of [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) can also see the `approvals_before_merge` parameter: ```json @@ -341,7 +341,7 @@ GET /users/:user_id/projects | `simple` | boolean | **{dotted-circle}** No | Return only limited fields for each project. Without authentication, this operation is a no-op; only simple fields are returned. | | `sort` | string | **{dotted-circle}** No | Return projects sorted in `asc` or `desc` order. Default is `desc`. | | `starred` | boolean | **{dotted-circle}** No | Limit by projects starred by the current user. | -| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Only available to Reporter or higher level role members. | +| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Available only to users with at least the Reporter role. | | `visibility` | string | **{dotted-circle}** No | Limit by visibility `public`, `internal`, or `private`. | | `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(administrator only)_ | | `with_issues_enabled` | boolean | **{dotted-circle}** No | Limit by enabled issues feature. | @@ -614,7 +614,7 @@ GET /users/:user_id/starred_projects | `simple` | boolean | **{dotted-circle}** No | Return only limited fields for each project. Without authentication, this operation is a no-op; only simple fields are returned. | | `sort` | string | **{dotted-circle}** No | Return projects sorted in `asc` or `desc` order. Default is `desc`. | | `starred` | boolean | **{dotted-circle}** No | Limit by projects starred by the current user. | -| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Only available to Reporter or higher level role members. | +| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Available only to users with at least the Reporter role. | | `visibility` | string | **{dotted-circle}** No | Limit by visibility `public`, `internal`, or `private`. | | `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(administrator only)_ | | `with_issues_enabled` | boolean | **{dotted-circle}** No | Limit by enabled issues feature. | @@ -864,7 +864,7 @@ GET /projects/:id |--------------------------|----------------|------------------------|-------------| | `id` | integer or string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | | `license` | boolean | **{dotted-circle}** No | Include project license data. | -| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Only available to Reporter or higher level role members. | +| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Available only to users with at least the Reporter role. | | `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(administrators only)_ | ```json @@ -1038,7 +1038,7 @@ NOTE: The `tag_list` attribute has been deprecated and is removed in API v5 in favor of the `topics` attribute. -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) +Users of [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) can also see the `approvals_before_merge` parameter: ```json @@ -1120,7 +1120,7 @@ target the upstream project by default. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55718) in GitLab 13.10. -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) +Users of [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) can also see the `issues_template` and `merge_requests_template` parameters for managing [issue and merge request description templates](../user/project/description_templates.md). @@ -1586,7 +1586,7 @@ GET /projects/:id/forks | `simple` | boolean | **{dotted-circle}** No | Return only limited fields for each project. Without authentication, this operation is a no-op; only simple fields are returned. | | `sort` | string | **{dotted-circle}** No | Return projects sorted in `asc` or `desc` order. Default is `desc`. | | `starred` | boolean | **{dotted-circle}** No | Limit by projects starred by the current user. | -| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Only available to Reporter or higher level role members. | +| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. Available only to users with at least the Reporter role. | | `visibility` | string | **{dotted-circle}** No | Limit by visibility `public`, `internal`, or `private`. | | `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(administrators only)_ | | `with_issues_enabled` | boolean | **{dotted-circle}** No | Limit by enabled issues feature. | @@ -2241,17 +2241,17 @@ This endpoint: - Deletes a project including all associated resources (including issues and merge requests). - In [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/issues/32935) and later, on - [Premium or higher](https://about.gitlab.com/pricing/) tiers, + [Premium or Ultimate](https://about.gitlab.com/pricing/) tiers, [delayed project deletion](../user/project/settings/index.md#delayed-project-deletion) is applied if enabled. - From [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) on - [Premium or higher](https://about.gitlab.com/pricing/) tiers, group + [Premium or Ultimate](https://about.gitlab.com/pricing/) tiers, group administrators can [configure](../user/group/manage.md#enable-delayed-project-deletion) projects within a group to be deleted after a delayed period. When enabled, actual deletion happens after the number of days specified in the [default deletion delay](../user/admin_area/settings/visibility_and_access_controls.md#deletion-protection). - From [GitLab 15.11](https://gitlab.com/gitlab-org/gitlab/-/issues/396500) on - [Premium or higher](https://about.gitlab.com/pricing/) tiers, deletes a project immediately if the project is already + [Premium or Ultimate](https://about.gitlab.com/pricing/) tiers, deletes a project immediately if the project is already marked for deletion, and the `permanently_remove` and `full_path` parameters are passed. WARNING: diff --git a/doc/api/rest/index.md b/doc/api/rest/index.md index 9365936aad8..0bee7168cfb 100644 --- a/doc/api/rest/index.md +++ b/doc/api/rest/index.md @@ -94,8 +94,8 @@ You can authenticate with the GitLab API in several ways: Project access tokens are supported by: -- Self-managed GitLab Free and higher. -- GitLab SaaS Premium and higher. +- Self-managed GitLab: Free, Premium, and Ultimate. +- GitLab SaaS: Premium and Ultimate. If you are an administrator, you or your application can authenticate as a specific user. To do so, use: diff --git a/doc/api/templates/dockerfiles.md b/doc/api/templates/dockerfiles.md index 31b676558db..e9d57061510 100644 --- a/doc/api/templates/dockerfiles.md +++ b/doc/api/templates/dockerfiles.md @@ -14,7 +14,7 @@ in the GitLab repository. ## Override Dockerfile API templates **(PREMIUM SELF)** -In [GitLab Premium and higher](https://about.gitlab.com/pricing/) tiers, GitLab instance +In [GitLab Premium and Ultimate](https://about.gitlab.com/pricing/) tiers, GitLab instance administrators can override templates in the [Admin Area](../../user/admin_area/settings/instance_template_repository.md). -- cgit v1.2.3