Updating the Basic Settings of a Repository Group
Function
This API is used to update the basic settings of a repository group.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
PUT https://{hostURL}/v4/groups/{group_id}/general-policy
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| group_id | Yes | Integer | Definition Repository group ID, which is the numeric ID next to Group ID on the repository group homepage. Value range: 1~2147483647 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| disable_fork | No | Boolean | Definition: Whether to disable fork. |
| branch_name_regex | No | String | Definition: Regular expression of the branch name Value range: 1–1,000 characters. |
| tag_name_regex | No | String | Definition: Regular expression of the tag name Value range: 1–1,000 characters. |
| generate_pre_merge_ref | No | Boolean | Definition: Generate a merge request for pre-merging |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| disable_fork | Boolean | Definition: Whether to disable fork. |
| branch_name_regex | String | Definition: Regular expression of the branch name Value range: 1–1,000 characters. |
| tag_name_regex | String | Definition: Regular expression of the tag name Value range: 1–1,000 characters. |
| generate_pre_merge_ref | Boolean | Definition: Generate a merge request for pre-merging |
Example Requests
Update the basic settings of a repository group
PUT https://{endpoint}/v4/groups/{group_id}/general-policy
{
"disable_fork" : false,
"branch_name_regex" : null,
"tag_name_regex" : null,
"generate_pre_merge_ref" : false
} Example Responses
Status code: 200
Basic settings of a project
{
"disable_fork" : false,
"branch_name_regex" : null,
"tag_name_regex" : null,
"generate_pre_merge_ref" : false
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Basic settings of a project |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
