병합 요청 승인 API

Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated
  • GitLab 16.0에서 /approvals 엔드포인트가 제거되었습니다.

프로젝트에서 모든 병합 요청에 대한 승인 구성. 모든 엔드포인트는 인증이 필요합니다.

그룹 수준 병합 요청 승인

Status: Experiment
  • GitLab 16.7에 플래그인 approval_group_rules와 함께 도입되었습니다. 기본적으로 비활성화되어 있습니다. 이 기능은 실험 중입니다.
자체 호스팅 GitLab에서는 기본적으로 이 기능을 사용할 수 없습니다. 관리자는 approval_group_rules라는 기능 플래그를 활성화할 수 있습니다. GitLab.com 및 GitLab Dedicated에서는 이 기능을 사용할 수 없습니다. 이 기능은 프로덕션 환경에 사용하기에 적합하지 않습니다.

그룹 승인 규칙은 그룹에 속한 프로젝트의 모든 보호된 브랜치에 적용됩니다. 이 기능은 실험 중입니다.

그룹 수준 승인 규칙 가져오기

  • GitLab 16.10에 도입되었습니다.

그룹 관리자는 다음 엔드포인트를 사용하여 그룹의 승인 규칙에 대한 정보를 요청할 수 있습니다: 

GET /groups/:id/approval_rules

page 및 per_page 페이징 매개변수를 사용하여 승인 규칙 목록을 제한하세요.

지원되는 속성:

속성 타입 필수 설명
id integer or string Yes 프로젝트의 ID 또는 URL 인코딩된 경로.

예시 요청: 

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/29/approval_rules"

예시 응답: 

[
  {
    "id": 2,
    "name": "rule1",
    "rule_type": "any_approver",
    "report_type": null,
    "eligible_approvers": [],
    "approvals_required": 3,
    "users": [],
    "groups": [],
    "contains_hidden_groups": false,
    "protected_branches": [],
    "applies_to_all_protected_branches": true
  },
  {
    "id": 3,
    "name": "rule2",
    "rule_type": "code_owner",
    "report_type": null,
    "eligible_approvers": [],
    "approvals_required": 2,
    "users": [],
    "groups": [],
    "contains_hidden_groups": false,
    "protected_branches": [],
    "applies_to_all_protected_branches": true
  },
  {
    "id": 4,
    "name": "rule2",
    "rule_type": "report_approver",
    "report_type": "code_coverage",
    "eligible_approvers": [],
    "approvals_required": 2,
    "users": [],
    "groups": [],
    "contains_hidden_groups": false,
    "protected_branches": [],
    "applies_to_all_protected_branches": true
  }
]

그룹 수준 승인 규칙 생성

그룹 관리자는 다음 엔드포인트를 사용하여 그룹 수준 승인 규칙을 생성할 수 있습니다: 

POST /groups/:id/approval_rules

지원되는 속성:

속성 타입 필수 설명
id integer or string Yes 그룹의 ID 또는 URL 인코딩된 경로.
approvals_required integer Yes 이 규칙에 필요한 승인 수.
name string Yes 승인 규칙의 이름.
group_ids array No 승인자로서 그룹의 ID.
rule_type string No 규칙 유형. any_approver는 approvals_required가 0인 사전 구성된 기본 규칙입니다. 다른 규칙은 regular (일반적으로 병합 요청 승인 규칙에 사용) 및 report_approver입니다. API에서 승인 규칙을 작성하지 않도록 이 필드를 사용하지 마세요. report_approver 필드는 GitLab이 구성되고 활성화된 병합 요청 승인 정책에서 승인 규칙을 생성할 때 사용됩니다.
user_ids array No 승인자로서 사용자의 ID.

예시 요청: 

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/29/approval_rules?name=security&approvals_required=2"

예시 응답: 

{
  "id": 5,
  "name": "security",
  "rule_type": "any_approver",
  "eligible_approvers": [],
  "approvals_required": 2,
  "users": [],
  "groups": [],
  "contains_hidden_groups": false,
  "protected_branches": [
    {
      "id": 5,
      "name": "master",
      "push_access_levels": [
        {
          "id": 5,
          "access_level": 40,
          "access_level_description": "Maintainers",
          "deploy_key_id": null,
          "user_id": null,
          "group_id": null
        }
      ],
      "merge_access_levels": [
        {
          "id": 5,
          "access_level": 40,
          "access_level_description": "Maintainers",
          "user_id": null,
          "group_id": null
        }
      ],
      "allow_force_push": false,
      "unprotect_access_levels": [],
      "code_owner_approval_required": false,
      "inherited": false
    }
  ],
  "applies_to_all_protected_branches": true
}

그룹 수준의 승인 규칙 업데이트

그룹 관리자는 다음 엔드포인트를 사용하여 그룹 수준의 승인 규칙을 업데이트할 수 있습니다: 

PUT /groups/:id/approval_rules/:approval_rule_id

지원되는 속성:

속성 유형 필수여부 설명
approval_rule_id. 정수 예 승인 규칙의 ID입니다.
id 정수 또는 문자열 예 그룹의 ID 또는 URL-인코딩 된 경로.
approvals_required 문자열 아니오 이 규칙에 필요한 승인 수입니다.
group_ids 정수 아니오 승인자로서 사용자의 ID입니다.
name 문자열 아니오 승인 규칙의 이름입니다.
rule_type 배열 아니오 규칙 유형입니다. any_approver는 approvals_required가 0인 사전 구성된 기본 규칙입니다. 다른 규칙은 정규적인 병합 요청 승인 규칙에 사용되는 regular과 report_approver입니다. API에서 승인 규칙을 구축하기 위해 이 필드를 사용하지 마십시오. report_approver 필드는 GitLab이 구성 및 활성화된 병합 요청 승인 정책에서 승인 규칙을 생성할 때 사용됩니다.
user_ids 배열 아니오 승인자로서 그룹의 ID입니다.

예시 요청: 

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/29/approval_rules/5?name=security2&approvals_required=1"

예시 응답: 

{
  "id": 5,
  "name": "security2",
  "rule_type": "any_approver",
  "eligible_approvers": [],
  "approvals_required": 1,
  "users": [],
  "groups": [],
  "contains_hidden_groups": false,
  "protected_branches": [
    {
      "id": 5,
      "name": "master",
      "push_access_levels": [
        {
          "id": 5,
          "access_level": 40,
          "access_level_description": "Maintainers",
          "deploy_key_id": null,
          "user_id": null,
          "group_id": null
        }
      ],
      "merge_access_levels": [
        {
          "id": 5,
          "access_level": 40,
          "access_level_description": "Maintainers",
          "user_id": null,
          "group_id": null
        }
      ],
      "allow_force_push": false,
      "unprotect_access_levels": [],
      "code_owner_approval_required": false,
      "inherited": false
    }
  ],
  "applies_to_all_protected_branches": true
}

프로젝트 수준 MR 승인

다음 엔드포인트를 사용하여 프로젝트의 승인 구성에 관한 정보를 요청할 수 있습니다: 

GET /projects/:id/approvals

지원되는 속성:

속성 유형 필수여부 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL-인코딩 된 경로. 
{
  "approvers": [], // GitLab 12.3에서 사용 중단됨, 항상 비어 반환
  "approver_groups": [], // GitLab 12.3에서 사용 중단됨, 항상 비어 반환
  "approvals_before_merge": 2, // GitLab 12.3에서 사용 중단됨, 대신 승인 규칙 사용
  "reset_approvals_on_push": true,
  "selective_code_owner_removals": false,
  "disable_overriding_approvers_per_merge_request": false,
  "merge_requests_author_approval": true,
  "merge_requests_disable_committers_approval": false,
  "require_password_to_approve": true, // GitLab 16.9에서 사용 중단됨, 대신 require_reauthentication_to_approve 사용
  "require_reauthentication_to_approve": true
}

구성 변경

적절한 역할을 가진 사용자는 다음 엔드포인트를 사용하여 승인 구성을 변경할 수 있습니다: 

POST /projects/:id/approvals

지원되는 속성:

속성 유형 필수여부 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL-인코딩 된 경로.
approvals_before_merge (사용 중단됨) 정수 아니오 병합 요청을 병합하기 전에 필요한 승인 수입니다. GitLab 12.3에서 사용 중단됨. 대신 승인 규칙 사용.
disable_overriding_approvers_per_merge_request 부울 아니오 병합 요청 당 승인자 무시 허용 여부 또는 예방 여부입니다.
merge_requests_author_approval 부울 아니오 작성자가 자체적으로 병합 요청을 승인할 수 있게하는 여부 또는 예방 여부입니다. true는 작성자가 자체 승인할 수 있음을 의미합니다.
merge_requests_disable_committers_approval 부울 아니오 커미터가 자체적으로 병합 요청을 승인할 수 있게 하는 여부 또는 예방 여부입니다.
require_password_to_approve (사용 중단됨) 부울 아니오 승인자가 승인을 추가하기 전에 암호를 입력해야 하는지 여부 또는 예방 여부입니다. GitLab 16.9에서 사용 중단되었습니다. 대신 require_reauthentication_to_approve 사용.
require_reauthentication_to_approve 부울 아니오 승인자가 승인을 추가하기 전에 인증을 다시 받아야 하는지 여부 또는 예방 여부입니다. GitLab 17.1에 도입되었습니다.
reset_approvals_on_push 부울 아니오 새 push시 승인 재설정 여부입니다.
selective_code_owner_removals 부울 아니오 코드 소유자의 승인을 변경하는 경우 승인 재설정 여부입니다. 이 필드를 사용하려면 reset_approvals_on_push 필드를 비활성화해야 합니다. 
{
  "approvals_before_merge": 2, // 승인 규칙 대신 사용
  "reset_approvals_on_push": true,
  "selective_code_owner_removals": false,
  "disable_overriding_approvers_per_merge_request": false,
  "merge_requests_author_approval": false,
  "merge_requests_disable_committers_approval": false,
  "require_password_to_approve": true,
  "require_reauthentication_to_approve": true
}

프로젝트 수준의 규칙 가져오기

  • 페이지네이션 지원은 GitLab 15.3에서 도입되었습니다. 플래그 approval_rules_pagination로 관리됩니다. 기본적으로 활성화됩니다.
  • applies_to_all_protected_branches 속성은 GitLab 15.3에서 도입되었습니다.
  • 페이지네이션 지원은 GitLab 15.7에서 일반적으로 제공됩니다. 기능 플래그 approval_rules_pagination가 제거되었습니다.
  • usernames 속성은 GitLab 15.8에서 도입되었습니다.

프로젝트의 승인 규칙에 대한 정보를 요청하려면 다음 엔드포인트를 사용하세요. 

GET /projects/:id/approval_rules

page 및 per_page 페이지네이션 매개변수를 사용하여 승인 규칙 목록을 제한합니다.

지원되는 속성:

속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로. 
[
  {
    "id": 1,
    "name": "security",
    "rule_type": "regular",
    "report_type": null,
    "eligible_approvers": [
      {
        "id": 5,
        "name": "John Doe",
        "username": "jdoe",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/jdoe"
      },
      {
        "id": 50,
        "name": "Group Member 1",
        "username": "group_member_1",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/group_member_1"
      }
    ],
    "approvals_required": 3,
    "users": [
      {
        "id": 5,
        "name": "John Doe",
        "username": "jdoe",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/jdoe"
      }
    ],
    "groups": [
      {
        "id": 5,
        "name": "group1",
        "path": "group1",
        "description": "",
        "visibility": "public",
        "lfs_enabled": false,
        "avatar_url": null,
        "web_url": "http://localhost/groups/group1",
        "request_access_enabled": false,
        "full_name": "group1",
        "full_path": "group1",
        "parent_id": null,
        "ldap_cn": null,
        "ldap_access": null
      }
    ],
    "applies_to_all_protected_branches": false,
    "protected_branches": [
      {
        "id": 1,
        "name": "main",
        "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"
      }
    ],
    "contains_hidden_groups": false,
  },
  {
    "id": 2,
    "name": "Coverage-Check",
    "rule_type": "report_approver",
    "report_type": "code_coverage",
    "eligible_approvers": [
      {
        "id": 5,
        "name": "John Doe",
        "username": "jdoe",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/jdoe"
      },
      {
        "id": 50,
        "name": "Group Member 1",
        "username": "group_member_1",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/group_member_1"
      }
    ],
    "approvals_required": 3,
    "users": [
      {
        "id": 5,
        "name": "John Doe",
        "username": "jdoe",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/jdoe"
      }
    ],
    "groups": [
      {
        "id": 5,
        "name": "group1",
        "path": "group1",
        "description": "",
        "visibility": "public",
        "lfs_enabled": false,
        "avatar_url": null,
        "web_url": "http://localhost/groups/group1",
        "request_access_enabled": false,
        "full_name": "group1",
        "full_path": "group1",
        "parent_id": null,
        "ldap_cn": null,
        "ldap_access": null
      }
    ],
    "applies_to_all_protected_branches": false,
    "protected_branches": [
      {
        "id": 1,
        "name": "main",
        "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"
      }
    ],
    "contains_hidden_groups": false,
  }
]

단일 프로젝트 수준의 규칙 가져오기

  • applies_to_all_protected_branches 속성은 GitLab 15.3에서 도입되었습니다.
  • usernames 속성은 GitLab 15.8에서 도입되었습니다.

다음 엔드포인트를 사용하여 단일 프로젝트 승인 규칙에 대한 정보를 요청할 수 있습니다. 

GET /projects/:id/approval_rules/:approval_rule_id

지원되는 속성:

속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
approval_rule_id 정수 예 승인 규칙의 ID입니다. 
{
  "id": 1,
  "name": "security",
  "rule_type": "regular",
  "report_type": null,
  "eligible_approvers": [
    {
      "id": 5,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    },
    {
      "id": 50,
      "name": "Group Member 1",
      "username": "group_member_1",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/group_member_1"
    }
  ],
  "approvals_required": 3,
  "users": [
    {
      "id": 5,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    }
  ],
  "groups": [
    {
      "id": 5,
      "name": "group1",
      "path": "group1",
      "description": "",
      "visibility": "public",
      "lfs_enabled": false,
      "avatar_url": null,
      "web_url": "http://localhost/groups/group1",
      "request_access_enabled": false,
      "full_name": "group1",
      "full_path": "group1",
      "parent_id": null,
      "ldap_cn": null,
      "ldap_access": null
    }
  ],
  "applies_to_all_protected_branches": false,
  "protected_branches": [
    {
      "id": 1,
      "name": "main",
      "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"
    }
  ],
  "contains_hidden_groups": false
}

프로젝트 수준의 규칙 생성

  • GitLab 15.0에서 취약성 확인 기능이 제거되었습니다.
  • applies_to_all_protected_branches 속성은 GitLab 15.3에서 도입되었습니다.
  • usernames 속성은 GitLab 15.8에서 도입되었습니다.

다음 엔드포인트를 사용하여 프로젝트 승인 규칙을 생성할 수 있습니다. 

POST /projects/:id/approval_rules

지원되는 속성:

속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
approvals_required 정수 예 이 규칙에 대해 필요한 승인 수입니다.
name 문자열 예 승인 규칙의 이름입니다.
applies_to_all_protected_branches 부울 아니오 모든 보호된 브랜치에 규칙을 적용할지 여부입니다. true로 설정하면 protected_branch_ids의 값은 무시됩니다. 기본값은 false입니다. GitLab 15.3에서 도입되었습니다.
group_ids 배열 아니오 승인자로서의 그룹 ID입니다.
protected_branch_ids 배열 아니오 규칙의 범위를 지정하는 보호된 브랜치의 ID입니다. ID를 식별하려면 API를 사용하세요.
report_type 문자열 아니오 규칙 유형이 report_approver인 경우 필요한 보고서 유형입니다. 지원되는 보고서 유형은 license_scanning (GitLab 15.9에서 폐기됨) 및 code_coverage입니다.
rule_type 문자열 아니오 규칙 유형입니다. any_approver는 approvals_required가 0인 사전 구성된 기본 규칙입니다. 다른 규칙은 regular(병합 요청 승인 규칙에 사용)과 report_approver입니다. API에서 승인 규칙을 작성하려면 이 필드를 사용하지 마세요. report_approver 필드는 GitLab이 구성되고 활성화된 병합 요청 승인 정책에서 승인 규칙을 만드는 경우에 사용됩니다.
user_ids 배열 아니오 승인자로서의 사용자 ID입니다. user_ids 및 usernames 둘 다 제공하면 두 사용자 목록이 모두 추가됩니다.
usernames 문자열 배열 아니오 이 규칙에 대한 승인자의 사용자 이름입니다(user_ids와 동일하지만 사용자 이름 목록이 필요합니다). user_ids 및 usernames 둘 다 제공하면 두 사용자 목록이 모두 추가됩니다. 
{
  "id": 1,
  "name": "security",
  "rule_type": "regular",
  "eligible_approvers": [
    {
      "id": 2,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    },
    {
      "id": 50,
      "name": "Group Member 1",
      "username": "group_member_1",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/group_member_1"
    }
  ],
  "approvals_required": 1,
  "users": [
    {
      "id": 2,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    }
  ],
  "groups": [
    {
      "id": 5,
      "name": "group1",
      "path": "group1",
      "description": "",
      "visibility": "public",
      "lfs_enabled": false,
      "avatar_url": null,
      "web_url": "http://localhost/groups/group1",
      "request_access_enabled": false,
      "full_name": "group1",
      "full_path": "group1",
      "parent_id": null,
      "ldap_cn": null,
      "ldap_access": null
    }
  ],
  "applies_to_all_protected_branches": false,
  "protected_branches": [
    {
      "id": 1,
      "name": "main",
      "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"
    }
  ],
  "contains_hidden_groups": false
}

다음과 같이 기본값이 0인 필요한 승인자 수를 늘릴 수 있습니다: 

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header 'Content-Type: application/json' \
  --data '{"name": "아무 이름", "rule_type": "any_approver", "approvals_required": 2}'

다른 예시로 사용자별 규칙을 생성하는 방법을 보여드리겠습니다: 

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header 'Content-Type: application/json' \
  --data '{"name": "규칙 이름", "approvals_required": 3, "user_ids": [123, 456, 789]}' \
  --url "https://gitlab.example.com/api/v4/projects/<project_id>/approval_rules"

### 프로젝트 수준 규칙 업데이트

> - GitLab 15.0에서 취약점 확인 기능이 [제거](https://gitlab.com/gitlab-org/gitlab/-/issues/357300)되었습니다.
> - GitLab 15.3에서 `applies_to_all_protected_branches` 속성이 [도입](https://gitlab.com/gitlab-org/gitlab/-/issues/335316)되었습니다.
> - GitLab 15.8에서 `usernames` 속성이 [도입](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102446)되었습니다.

다음 엔드포인트를 사용하여 프로젝트 승인 규칙을 업데이트할 수 있습니다:

```plaintext
PUT /projects/:id/approval_rules/:approval_rule_id

참고: 승인자 및 그룹은 (사용자 또는 그룹에 속하지 않은 숨겨진 그룹을 제외하고) 제거됩니다. 숨겨진 그룹이란 사용자가 보기 권한을 갖지 않는 비공개 그룹을 의미합니다. remove_hidden_groups 매개변수가 true인 경우가 아닌 한, 기본적으로 숨겨진 그룹은 제거되지 않습니다. 이는 사용자가 승인 규칙을 업데이트할 때 실수로 숨겨진 그룹이 제거되지 않도록 보장합니다.

지원되는 속성:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩 된 경로.
approvals_required 정수 예 이 규칙에 필요한 승인 수입니다.
approval_rule_id 정수 예 승인 규칙의 ID입니다.
name 문자열 예 승인 규칙의 이름입니다.
applies_to_all_protected_branches 부울 아니오 모든 보호된 브랜치에 규칙을 적용할지 여부입니다. true로 설정하면 protected_branch_ids의 값은 무시됩니다. 기본값은 false입니다. GitLab 15.3에서 도입되었습니다.
group_ids 배열 아니오 승인자로서의 그룹 ID입니다.
protected_branch_ids 배열 아니오 규칙을 범위로 설정할 보호된 브랜치의 ID입니다. ID를 식별하려면 API를 사용하십시오.
remove_hidden_groups 부울 아니오 승인 규칙에서 숨겨진 그룹을 제거할지 여부입니다.
user_ids 배열 아니오 승인자로서의 사용자 ID입니다. user_ids 및 usernames를 모두 제공하는 경우 두 사용자 목록이 모두 추가됩니다.
usernames 문자열 배열 아니오 이 규칙에 대한 승인자의 사용자 이름입니다(user_ids와 같지만 사용자 이름 목록이 필요합니다). user_ids 및 usernames를 모두 제공하는 경우 두 사용자 목록이 모두 추가됩니다. 
{
  "id": 1,
  "name": "security",
  "rule_type": "regular",
  "eligible_approvers": [
    {
      "id": 2,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    },
    {
      "id": 50,
      "name": "Group Member 1",
      "username": "group_member_1",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/group_member_1"
    }
  ],
  "approvals_required": 1,
  "users": [
    {
      "id": 2,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    }
  ],
  "groups": [
    {
      "id": 5,
      "name": "group1",
      "path": "group1",
      "description": "",
      "visibility": "public",
      "lfs_enabled": false,
      "avatar_url": null,
      "web_url": "http://localhost/groups/group1",
      "request_access_enabled": false,
      "full_name": "group1",
      "full_path": "group1",
      "parent_id": null,
      "ldap_cn": null,
      "ldap_access": null
    }
  ],
  "applies_to_all_protected_branches": false,
  "protected_branches": [
    {
      "id": 1,
      "name": "main",
      "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"
    }
  ],
  "contains_hidden_groups": false
}

프로젝트 수준 규칙 삭제

다음 엔드포인트를 사용하여 프로젝트 승인 규칙을 삭제할 수 있습니다: 

DELETE /projects/:id/approval_rules/:approval_rule_id

지원되는 속성:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩 된 경로.
approval_rule_id 정수 예 승인 규칙의 ID입니다.

병합 요청 수준 MR 승인

특정 병합 요청에 대한 승인을 구성합니다. 모든 엔드포인트는 인증이 필요합니다.

다음 엔드포인트를 사용하여 병합 요청의 승인 상태에 대한 정보를 요청할 수 있습니다: 

GET /projects/:id/merge_requests/:merge_request_iid/approvals

지원되는 속성:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩 된 경로.
merge_request_iid 정수 예 병합 요청의 IID입니다. 
{
  "id": 5,
  "iid": 5,
  "project_id": 1,
  "title": "승인 API",
  "description": "테스트",
  "state": "opened",
  "created_at": "2016-06-08T00:19:52.638Z",
  "updated_at": "2016-06-08T21:20:42.470Z",
  "merge_status": "cannot_be_merged",
  "approvals_required": 2,
  "approvals_left": 1,
  "approved_by": [
    {
      "user": {
        "name": "관리자",
        "username": "root",
        "id": 1,
        "state": "active",
        "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon",
        "web_url": "http://localhost:3000/root"
      }
    }
  ]
}

병합 요청의 승인 상태 가져오기

다음 엔드포인트를 사용하여 병합 요청의 승인 상태에 대한 정보를 요청할 수 있습니다. 

GET /projects/:id/merge_requests/:merge_request_iid/approval_state

approval_rules_overwritten은 병합 요청 수준의 규칙이 병합 요청에 대해 생성된 경우 true입니다. 규칙이 없는 경우 false입니다.

이에는 이미 승인한 사용자(approved_by) 및 규칙이 이미 승인되었는지 여부(approved)에 대한 더 많은 정보가 포함됩니다.

지원되는 속성:

속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL로 인코딩된 경로(rest/index.md#namespaced-paths).
merge_request_iid 정수 예 병합 요청의 IID. 
{
  "approval_rules_overwritten": true,
  "rules": [
    {
      "id": 1,
      "name": "Ruby",
      "rule_type": "regular",
      "eligible_approvers": [
        {
          "id": 4,
          "name": "John Doe",
          "username": "jdoe",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
          "web_url": "http://localhost/jdoe"
        }
      ],
      "approvals_required": 2,
      "users": [
        {
          "id": 4,
          "name": "John Doe",
          "username": "jdoe",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
          "web_url": "http://localhost/jdoe"
        }
      ],
      "groups": [],
      "contains_hidden_groups": false,
      "approved_by": [
        {
          "id": 4,
          "name": "John Doe",
          "username": "jdoe",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
          "web_url": "http://localhost/jdoe"
        }
      ],
      "source_rule": null,
      "approved": true,
      "overridden": false
    }
  ]
}

병합 요청 수준의 규칙 가져오기

  • GitLab 15.3에 도입된 페이지네이션 지원 플래그approval_rules_pagination와 함께.
  • GitLab 15.7에서 페이지네이션 지원이 일반 사용 가능해짐. 기능 플래그 approval_rules_pagination 제거됨.

다음 엔드포인트를 사용하여 병합 요청의 승인 규칙에 대한 정보를 요청할 수 있습니다. 

GET /projects/:id/merge_requests/:merge_request_iid/approval_rules

page 및 per_page 페이지네이션 매개변수를 사용하여 승인 규칙 목록을 제약할 수 있습니다.

지원되는 속성:

속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL로 인코딩된 경로(rest/index.md#namespaced-paths).
merge_request_iid 정수 예 병합 요청의 IID. 
[
  {
    "id": 1,
    "name": "security",
    "rule_type": "regular",
    "report_type": null,
    "eligible_approvers": [
      {
        "id": 5,
        "name": "John Doe",
        "username": "jdoe",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/jdoe"
      },
      {
        "id": 50,
        "name": "Group Member 1",
        "username": "group_member_1",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/group_member_1"
      }
    ],
    "approvals_required": 3,
    "source_rule": null,
    "users": [
      {
        "id": 5,
        "name": "John Doe",
        "username": "jdoe",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/jdoe"
      }
    ],
    "groups": [
      {
        "id": 5,
        "name": "group1",
        "path": "group1",
        "description": "",
        "visibility": "public",
        "lfs_enabled": false,
        "avatar_url": null,
        "web_url": "http://localhost/groups/group1",
        "request_access_enabled": false,
        "full_name": "group1",
        "full_path": "group1",
        "parent_id": null,
        "ldap_cn": null,
        "ldap_access": null
      }
    ],
    "contains_hidden_groups": false,
    "overridden": false
  },
  {
    "id": 2,
    "name": "Coverage-Check",
    "rule_type": "report_approver",
    "report_type": "code_coverage",
    "eligible_approvers": [
      {
        "id": 5,
        "name": "John Doe",
        "username": "jdoe",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/jdoe"
      },
      {
        "id": 50,
        "name": "Group Member 1",
        "username": "group_member_1",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/group_member_1"
      }
    ],
    "approvals_required": 3,
    "source_rule": null,
    "users": [
      {
        "id": 5,
        "name": "John Doe",
        "username": "jdoe",
        "state": "active",
        "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
        "web_url": "http://localhost/jdoe"
      }
    ],
    "groups": [
      {
        "id": 5,
        "name": "group1",
        "path": "group1",
        "description": "",
        "visibility": "public",
        "lfs_enabled": false,
        "avatar_url": null,
        "web_url": "http://localhost/groups/group1",
        "request_access_enabled": false,
        "full_name": "group1",
        "full_path": "group1",
        "parent_id": null,
        "ldap_cn": null,
        "ldap_access": null
      }
    ],
    "contains_hidden_groups": false,
    "overridden": false
  }
]

단일 병합 요청 수준 규칙 가져오기

다음 엔드포인트를 사용하여 단일 병합 요청 승인 규칙에 대한 정보를 요청할 수 있습니다. 

GET /projects/:id/merge_requests/:merge_request_iid/approval_rules/:approval_rule_id

지원되는 속성:

속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL로 인코딩된 경로.
approval_rule_id 정수 예 승인 규칙의 ID.
merge_request_iid 정수 예 병합 요청의 IID. 
{
  "id": 1,
  "name": "security",
  "rule_type": "regular",
  "report_type": null,
  "eligible_approvers": [
    {
      "id": 5,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    },
    {
      "id": 50,
      "name": "Group Member 1",
      "username": "group_member_1",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/group_member_1"
    }
  ],
  "approvals_required": 3,
  "source_rule": null,
  "users": [
    {
      "id": 5,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    }
  ],
  "groups": [
    {
      "id": 5,
      "name": "group1",
      "path": "group1",
      "description": "",
      "visibility": "public",
      "lfs_enabled": false,
      "avatar_url": null,
      "web_url": "http://localhost/groups/group1",
      "request_access_enabled": false,
      "full_name": "group1",
      "full_path": "group1",
      "parent_id": null,
      "ldap_cn": null,
      "ldap_access": null
    }
  ],
  "contains_hidden_groups": false,
  "overridden": false
}

병합 요청 수준 규칙 생성

다음 엔드포인트를 사용하여 병합 요청 승인 규칙을 생성할 수 있습니다. 

POST /projects/:id/merge_requests/:merge_request_iid/approval_rules

지원되는 속성:

속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL로 인코딩된 경로
approvals_required 정수 예 이 규칙에 필요한 승인 수.
merge_request_iid 정수 예 병합 요청의 IID.
name 문자열 예 승인 규칙의 이름.
approval_project_rule_id 정수 아니요 프로젝트 수준 승인 규칙의 ID.
group_ids 배열 아니요 승인자로서 그룹의 ID.
user_ids 배열 아니요 승인자로서 사용자의 ID. user_ids 및 usernames 둘 다 제공하면 두 사용자 목록이 추가됩니다.
usernames 문자열 배열 아니요 이 규칙의 승인자의 사용자 이름 (user_ids와 동일하지만 사용자 이름 목록이 필요합니다). user_ids 및 usernames 둘 다 제공하면 두 사용자 목록이 추가됩니다.

참고: approval_project_rule_id를 설정하면 프로젝트 수준 규칙의 name, users, groups가 복사됩니다. 지정한 approvals_required가 사용됩니다. 

{
  "id": 1,
  "name": "security",
  "rule_type": "regular",
  "eligible_approvers": [
    {
      "id": 2,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    },
    {
      "id": 50,
      "name": "Group Member 1",
      "username": "group_member_1",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/group_member_1"
    }
  ],
  "approvals_required": 1,
  "source_rule": null,
  "users": [
    {
      "id": 2,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    }
  ],
  "groups": [
    {
      "id": 5,
      "name": "group1",
      "path": "group1",
      "description": "",
      "visibility": "public",
      "lfs_enabled": false,
      "avatar_url": null,
      "web_url": "http://localhost/groups/group1",
      "request_access_enabled": false,
      "full_name": "group1",
      "full_path": "group1",
      "parent_id": null,
      "ldap_cn": null,
      "ldap_access": null
    }
  ],
  "contains_hidden_groups": false,
  "overridden": false
}

### 병합 요청 수준 규칙 업데이트

병합 요청 승인 규칙을 업데이트하려면 이 엔드포인트를 사용하세요:

```plaintext
PUT /projects/:id/merge_requests/:merge_request_iid/approval_rules/:approval_rule_id

이 엔드포인트는 users 또는 groups 매개변수에 없는 승인자 및 그룹을 제거합니다.

report_approver 또는 code_owner 규칙은 시스템에서 생성되는 규칙이므로 업데이트할 수 없습니다.

지원되는 속성:

속성명 유형 필수 여부 설명
id integer 또는 string Yes 프로젝트의 ID 또는 URL 인코딩된 경로.
approval_rule_id integer Yes 승인 규칙의 ID.
merge_request_iid integer Yes 병합 요청의 IID.
approvals_required integer No 이 규칙에 필요한 승인 수.
group_ids Array No 승인자로서의 그룹 ID.
name string No 승인 규칙의 이름.
remove_hidden_groups boolean No 숨겨진 그룹을 제거할지 여부.
user_ids Array No 승인자로서의 사용자 ID. user_ids 및 usernames를 모두 제공하는 경우 두 사용자 목록이 추가됩니다.
usernames string array No 이 규칙의 승인자의 사용자 이름 (user_ids와 동일하지만 사용자 이름 목록이 필요함). user_ids 및 usernames를 모두 제공하는 경우 두 사용자 목록이 추가됩니다. 
{
  "id": 1,
  "name": "security",
  "rule_type": "regular",
  "eligible_approvers": [
    {
      "id": 2,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    },
    {
      "id": 50,
      "name": "Group Member 1",
      "username": "group_member_1",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/group_member_1"
    }
  ],
  "approvals_required": 1,
  "source_rule": null,
  "users": [
    {
      "id": 2,
      "name": "John Doe",
      "username": "jdoe",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
      "web_url": "http://localhost/jdoe"
    }
  ],
  "groups": [
    {
      "id": 5,
      "name": "group1",
      "path": "group1",
      "description": "",
      "visibility": "public",
      "lfs_enabled": false,
      "avatar_url": null,
      "web_url": "http://localhost/groups/group1",
      "request_access_enabled": false,
      "full_name": "group1",
      "full_path": "group1",
      "parent_id": null,
      "ldap_cn": null,
      "ldap_access": null
    }
  ],
  "contains_hidden_groups": false,
  "overridden": false
}

병합 요청 수준 규칙 삭제

다음 엔드포인트를 사용하여 병합 요청 승인 규칙을 삭제할 수 있습니다: 

DELETE /projects/:id/merge_requests/:merge_request_iid/approval_rules/:approval_rule_id

report_approver 또는 code_owner 규칙은 시스템에서 생성되는 규칙이므로 업데이트할 수 없습니다.

지원되는 속성:

속성명 유형 필수 여부 설명
id integer 또는 string Yes 프로젝트의 ID 또는 URL 인코딩된 경로.
approval_rule_id integer Yes 승인 규칙의 ID.
merge_request_iid integer Yes 병합 요청의 IID.

병합 요청 승인

적절한 역할을 가진 사용자는 이 엔드포인트를 사용하여 병합 요청을 승인할 수 있습니다: 

POST /projects/:id/merge_requests/:merge_request_iid/approve

지원되는 속성:

| 속성명 | 유형 | 필수 여부 | 설명 | |———————|——————-|———-|————-| | id | integer 또는 string | Yes | 프로젝트의 ID 또는 URL 인코딩된 경로. | | approval_password | string | No | 현재 사용자의 암호. 프로젝트 설정에서 승인을 위해 사용자 재인증 필요가 활성화된 경우 필요합니다. 그룹이나 온프레미스 인스턴스가 SAML 인증을 강제로 구성된 경우 항상 실패합니다. | | merge_request_iid | integer | Yes | 병합 요청의 IID. | | sha | string | No | 병합 요청의 HEAD. | ``` sha 매개변수는 병합 요청을 승인할 때와 같은 방식으로 작동합니다. 전달된 경우 현재 병합 요청의 HEAD와 일치해야 합니다. 일치하지 않으면 응답 코드가 409입니다. 

{
  "id": 5,
  "iid": 5,
  "project_id": 1,
  "title": "Approvals API",
  "description": "Test",
  "state": "opened",
  "created_at": "2016-06-08T00:19:52.638Z",
  "updated_at": "2016-06-09T21:32:14.105Z",
  "merge_status": "can_be_merged",
  "approvals_required": 2,
  "approvals_left": 0,
  "approved_by": [
    {
      "user": {
        "name": "Administrator",
        "username": "root",
        "id": 1,
        "state": "active",
        "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon",
        "web_url": "http://localhost:3000/root"
      }
    },
    {
      "user": {
        "name": "Nico Cartwright",
        "username": "ryley",
        "id": 2,
        "state": "active",
        "avatar_url": "http://www.gravatar.com/avatar/cf7ad14b34162a76d593e3affca2adca?s=80\u0026d=identicon",
        "web_url": "http://localhost:3000/ryley"
      }
    }
  ]
}

병합 요청 승인 취소

병합 요청을 승인했다면, 다음 엔드포인트를 사용하여 승인을 취소할 수 있습니다. 

POST /projects/:id/merge_requests/:merge_request_iid/unapprove

지원되는 속성:

속성 유형 필수 여부 설명
id 정수 또는 문자열 Yes 프로젝트의 ID 또는 URL-encoded path.
merge_request_iid 정수 Yes 병합 요청의 내부 ID.

병합 요청의 승인 초기화

병합 요청의 모든 승인을 지웁니다.

프로젝트 또는 그룹 토큰을 기반으로 하는 봇 사용자만 이용할 수 있습니다. 봇 권한이 없는 사용자는 401 Unauthorized 응답을 받습니다. 

PUT /projects/:id/merge_requests/:merge_request_iid/reset_approvals
속성 유형 필수 여부 설명
id 정수 또는 문자열 Yes 프로젝트의 ID 또는 URL-encoded path.
merge_request_iid 정수 Yes 병합 요청의 내부 ID. 
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/76/merge_requests/1/reset_approvals"