Merge branch 'docs/code-owners-api' into 'master'

Docs for protected branch code owner approval API

See merge request gitlab-org/gitlab!17132

doc/api/protected_branches.md

@@ -46,7 +46,8 @@ Example response:
         "access_level": 40,
         "access_level_description": "Maintainers"
       }
-    ]
+    ],
+    "code_owner_approval_required": "false"
   },
   ...
 ]
@@ -76,7 +77,8 @@ Example response:
         "group_id": 1234,
         "access_level_description": "Example Merge Group"
       }
-    ]
+    ],
+    "code_owner_approval_required": "false"
   },
   ...
 ]
@@ -115,7 +117,8 @@ Example response:
       "access_level": 40,
       "access_level_description": "Maintainers"
     }
-  ]
+  ],
+  "code_owner_approval_required": "false"
 }
 ```
 
@@ -142,7 +145,8 @@ Example response:
       "group_id": 1234,
       "access_level_description": "Example Merge Group"
     }
-  ]
+  ],
+  "code_owner_approval_required": "false"
 }
 ```
 
@@ -168,7 +172,8 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitla
 | `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_unprotect`          | array          | no  | **(STARTER)** 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:
 
@@ -192,7 +197,8 @@ Example response:
       "access_level": 40,
       "access_level_description": "Maintainers"
     }
-  ]
+  ],
+  "code_owner_approval_required": "false"
 }
 ```
 
@@ -227,7 +233,8 @@ Example response:
       "group_id": null,
       "access_level_description": "Maintainers"
     }
-  ]
+  ],
+  "code_owner_approval_required": "false"
 }
 ```
 
@@ -268,7 +275,8 @@ Example response:
       "group_id": null,
       "access_level_description": "Maintainers"
     }
-  ]
+  ],
+  "code_owner_approval_required": "false"
 }
 ```
 

ee/changelogs/unreleased/docs-code-owners-api.yml

+---
+title: Docs for protected branch code owner approval API
+merge_request: 17132
+author:
+type: other