summaryrefslogtreecommitdiff
path: root/doc/api/merge_request_approvals.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-04-20 14:36:54 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2021-04-20 14:36:54 +0000
commitf61bb2a16a514b71bf33aabbbb999d6732016a24 (patch)
tree9548caa89e60b4f40b99bbd1dac030420b812aa8 /doc/api/merge_request_approvals.md
parent35fc54e5d261f8898e390aea7c2f5ec5fdf0539d (diff)
downloadgitlab-ce-13.11.0-rc42.tar.gz
Add latest changes from gitlab-org/gitlab@13-11-stable-eev13.11.0-rc42
Diffstat (limited to 'doc/api/merge_request_approvals.md')
-rw-r--r--doc/api/merge_request_approvals.md147
1 files changed, 4 insertions, 143 deletions
diff --git a/doc/api/merge_request_approvals.md b/doc/api/merge_request_approvals.md
index ea049c46e73..be973518d89 100644
--- a/doc/api/merge_request_approvals.md
+++ b/doc/api/merge_request_approvals.md
@@ -7,7 +7,9 @@ type: reference, api
# Merge request approvals API **(PREMIUM)**
-Configuration for approvals on all Merge Requests (MR) in the project. Must be authenticated for all endpoints.
+Configuration for
+[approvals on all merge requests](../user/project/merge_requests/merge_request_approvals.md)
+in the project. Must be authenticated for all endpoints.
## Project-level MR approvals
@@ -501,72 +503,6 @@ DELETE /projects/:id/approval_rules/:approval_rule_id
| `id` | integer | yes | The ID of a project |
| `approval_rule_id` | integer | yes | The ID of a approval rule
-### Change allowed approvers
-
-> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in GitLab 10.6.
-> - Moved to GitLab Premium in 13.9.
-
-NOTE:
-This API endpoint has been deprecated. Please use Approval Rule API instead.
-
-If you are allowed to, you can change approvers and approver groups using
-the following endpoint:
-
-```plaintext
-PUT /projects/:id/approvers
-```
-
-**Important:** Approvers and groups not in the request are **removed**
-
-**Parameters:**
-
-| Attribute | Type | Required | Description |
-| -------------------- | ------- | -------- | --------------------------------------------------- |
-| `id` | integer | yes | The ID of a project |
-| `approver_ids` | Array | yes | An array of User IDs that can approve MRs |
-| `approver_group_ids` | Array | yes | An array of Group IDs whose members can approve MRs |
-
-```json
-{
- "approvers": [
- {
- "user": {
- "id": 5,
- "name": "John Doe6",
- "username": "user5",
- "state":"active","avatar_url":"https://www.gravatar.com/avatar/4aea8cf834ed91844a2da4ff7ae6b491?s=80\u0026d=identicon","web_url":"http://localhost/user5"
- }
- }
- ],
- "approver_groups": [
- {
- "group": {
- "id": 1,
- "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
- }
- }
- ],
- "approvals_before_merge": 2,
- "reset_approvals_on_push": true,
- "disable_overriding_approvers_per_merge_request": false,
- "merge_requests_author_approval": true,
- "merge_requests_disable_committers_approval": false,
- "require_password_to_approve": true
-}
-```
-
## External Project-level MR approvals **(ULTIMATE)**
Configuration for approvals on a specific Merge Request which makes a call to an external HTTP resource.
@@ -645,7 +581,7 @@ DELETE /projects/:id/external_approval_rules/:rule_id
You can update an existing external approval rule for a project using the following endpoint:
```plaintext
-PATCH /projects/:id/external_approval_rules/:rule_id
+PUT /projects/:id/external_approval_rules/:rule_id
```
| Attribute | Type | Required | Description |
@@ -769,81 +705,6 @@ POST /projects/:id/merge_requests/:merge_request_iid/approvals
}
```
-### Change allowed approvers for Merge Request
-
-> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in GitLab 10.6.
-> - Moved to GitLab Premium in 13.9.
-
-NOTE:
-This API endpoint has been deprecated. Please use Approval Rule API instead.
-
-If you are allowed to, you can change approvers and approver groups using
-the following endpoint:
-
-```plaintext
-PUT /projects/:id/merge_requests/:merge_request_iid/approvers
-```
-
-**Important:** Approvers and groups not in the request are **removed**
-
-**Parameters:**
-
-| Attribute | Type | Required | Description |
-|----------------------|---------|----------|-----------------------------------------------------------|
-| `id` | integer | yes | The ID of a project |
-| `merge_request_iid` | integer | yes | The IID of MR |
-| `approver_ids` | Array | yes | An array of User IDs that can approve the MR |
-| `approver_group_ids` | Array | yes | An array of Group IDs whose members can approve the MR |
-
-```json
-{
- "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-08T21:20:42.470Z",
- "merge_status": "cannot_be_merged",
- "approvals_required": 2,
- "approvals_left": 2,
- "approved_by": [],
- "approvers": [
- {
- "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"
- }
- }
- ],
- "approver_groups": [
- {
- "group": {
- "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
- }
- }
- ]
-}
-```
-
### Get the approval state of merge requests
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13712) in GitLab 12.3.