diff options
Diffstat (limited to 'doc/api/protected_branches.md')
| -rw-r--r-- | doc/api/protected_branches.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md index 1dd15231dd8..9ff4e374311 100644 --- a/doc/api/protected_branches.md +++ b/doc/api/protected_branches.md @@ -62,7 +62,7 @@ Example response: ] ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see +Users on GitLab Premium or higher also see the `user_id` and `group_id` parameters: Example response: @@ -133,7 +133,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see +Users on GitLab Premium or higher also see the `user_id` and `group_id` parameters: Example response: @@ -182,9 +182,9 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla | `push_access_level` | string | no | Access levels allowed to push (defaults: `40`, maintainer access level) | | `merge_access_level` | string | no | Access levels allowed to merge (defaults: `40`, maintainer access level) | | `unprotect_access_level` | string | no | Access levels allowed to unprotect (defaults: `40`, maintainer access level) | -| `allowed_to_push` | array | no | **(STARTER)** Array of access levels allowed to push, with each described by a hash | -| `allowed_to_merge` | array | no | **(STARTER)** Array of access levels allowed to merge, with each described by a hash | -| `allowed_to_unprotect` | array | no | **(STARTER)** Array of access levels allowed to unprotect, with each described by a hash | +| `allowed_to_push` | array | no | **(PREMIUM)** Array of access levels allowed to push, with each described by a hash | +| `allowed_to_merge` | array | no | **(PREMIUM)** Array of access levels allowed to merge, with each described by a hash | +| `allowed_to_unprotect` | array | no | **(PREMIUM)** Array of access levels allowed to unprotect, with each described by a hash | | `code_owner_approval_required` | boolean | no | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the [`CODEOWNERS` file](../user/project/code_owners.md). (defaults: false) | Example response: @@ -215,7 +215,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see +Users on GitLab Premium or higher also see the `user_id` and `group_id` parameters: Example response: @@ -252,7 +252,7 @@ Example response: } ``` -### Example with user / group level access **(STARTER)** +### Example with user / group level access **(PREMIUM)** Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` array should take the form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users) and were [added to the API](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3516) in GitLab 10.3 EE. @@ -295,7 +295,9 @@ Example response: } ``` -### Example with allow to push and allow to merge access **(STARTER)** +### Example with allow to push and allow to merge access **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. Example request: @@ -375,7 +377,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git ## Require code owner approvals for a single branch -Update the "code owner approval required" option for the given protected branch protected branch. +Update the "code owner approval required" option for the given protected branch. ```plaintext PATCH /projects/:id/protected_branches/:name |