Protected branches API

原文：https://docs.gitlab.com/ee/api/protected_branches.html

• List protected branches
• Get a single protected branch or wildcard protected branch
• Protect repository branches
  • Example with user / group level access
• Unprotect repository branches
• Require code owner approvals for a single branch

Protected branches API

注意：此功能是在 GitLab 9.5 中引入的

有效的访问级别

访问级别在ProtectedRefAccess.allowed_access_levels方法中定义. 当前，这些级别被认可：

0  => No access
30 => Developer access
40 => Maintainer access
60 => Admin access

List protected branches

从项目中获取受保护分支的列表.

GET /projects/:id/protected_branches

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches"

响应示例：

[  {  "id":  1,  "name":  "master",  "push_access_levels":  [  {  "access_level":  40,  "access_level_description":  "Maintainers"  }  ],  "merge_access_levels":  [  {  "access_level":  40,  "access_level_description":  "Maintainers"  }  ],  "code_owner_approval_required":  "false"  },  ...  ]

使用 GitLab Starter，Bronze 或更高版本的用户还将看到user_id和group_id参数：

响应示例：

[  {  "id":  1,  "name":  "master",  "push_access_levels":  [  {  "access_level":  40,  "user_id":  null,  "group_id":  null,  "access_level_description":  "Maintainers"  }  ],  "merge_access_levels":  [  {  "access_level":  null,  "user_id":  null,  "group_id":  1234,  "access_level_description":  "Example Merge Group"  }  ],  "code_owner_approval_required":  "false"  },  ...  ]

Get a single protected branch or wildcard protected branch

获取单个受保护分支或通配符受保护分支.

GET /projects/:id/protected_branches/:name

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/master"

响应示例：

{  "id":  1,  "name":  "master",  "push_access_levels":  [  {  "access_level":  40,  "access_level_description":  "Maintainers"  }  ],  "merge_access_levels":  [  {  "access_level":  40,  "access_level_description":  "Maintainers"  }  ],  "code_owner_approval_required":  "false"  }

使用 GitLab Starter，Bronze 或更高版本的用户还将看到user_id和group_id参数：

响应示例：

{  "id":  1,  "name":  "master",  "push_access_levels":  [  {  "access_level":  40,  "user_id":  null,  "group_id":  null,  "access_level_description":  "Maintainers"  }  ],  "merge_access_levels":  [  {  "access_level":  null,  "user_id":  null,  "group_id":  1234,  "access_level_description":  "Example Merge Group"  }  ],  "code_owner_approval_required":  "false"  }

Protect repository branches

使用通配符保护的分支来保护单个存储库分支或几个项目存储库分支.

POST /projects/:id/protected_branches

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&push_access_level=30&merge_access_level=30&unprotect_access_level=40"

响应示例：

{  "id":  1,  "name":  "*-stable",  "push_access_levels":  [  {  "access_level":  30,  "access_level_description":  "Developers + Maintainers"  }  ],  "merge_access_levels":  [  {  "access_level":  30,  "access_level_description":  "Developers + Maintainers"  }  ],  "unprotect_access_levels":  [  {  "access_level":  40,  "access_level_description":  "Maintainers"  }  ],  "code_owner_approval_required":  "false"  }

使用 GitLab Starter，Bronze 或更高版本的用户还将看到user_id和group_id参数：

响应示例：

{  "id":  1,  "name":  "*-stable",  "push_access_levels":  [  {  "access_level":  30,  "user_id":  null,  "group_id":  null,  "access_level_description":  "Developers + Maintainers"  }  ],  "merge_access_levels":  [  {  "access_level":  30,  "user_id":  null,  "group_id":  null,  "access_level_description":  "Developers + Maintainers"  }  ],  "unprotect_access_levels":  [  {  "access_level":  40,  "user_id":  null,  "group_id":  null,  "access_level_description":  "Maintainers"  }  ],  "code_owner_approval_required":  "false"  }

Example with user / group level access

allowed_to_push / allowed_to_merge / allowed_to_unprotect数组中的元素应采用{user_id: integer} ， {group_id: integer}或{access_level: integer} . 每个用户必须有权访问该项目，并且每个组都必须共享该项目 . 这些访问级别允许对受保护的分支访问进行更精细的控制，并在 GitLab 10.3 EE 中将其添加到 API 中 .

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&allowed_to_push%5B%5D%5Buser_id%5D=1"

响应示例：

{  "id":  1,  "name":  "*-stable",  "push_access_levels":  [  {  "access_level":  null,  "user_id":  1,  "group_id":  null,  "access_level_description":  "Administrator"  }  ],  "merge_access_levels":  [  {  "access_level":  40,  "user_id":  null,  "group_id":  null,  "access_level_description":  "Maintainers"  }  ],  "unprotect_access_levels":  [  {  "access_level":  40,  "user_id":  null,  "group_id":  null,  "access_level_description":  "Maintainers"  }  ],  "code_owner_approval_required":  "false"  }

Unprotect repository branches

取消保护给定的受保护分支或通配符受保护分支.

DELETE /projects/:id/protected_branches/:name

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/*-stable"

Require code owner approvals for a single branch

为给定的受保护分支受保护分支更新”需要代码所有者批准”选项.

PATCH /projects/:id/protected_branches/:name

curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/feature-branch"