Viewing the General Commit Rules of the Repository
Function
This API is used to view the general commit rules of the repository.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET https://{hostURL}/v4/repositories/{repository_id}/general-commit-rule
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| repository_id | Yes | Integer | Definition You can query the project list to obtain the repository ID by calling the API used to query user's all repositories. Constraints N/A. 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. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| reject_unsigned_commits | Boolean | Definition: Whether to reject non-signed-off-by commits. Constraints: N/A. Value range: Default value: N/A. |
| reject_not_signed_by_gpg | Boolean | Definition: Whether to reject commits not signed by GPG. Constraints: N/A. Value range: Default value: N/A. |
| deny_delete_tag | Boolean | Definition: Whether tags can be deleted. Constraints: N/A. Value range: Default value: N/A. |
| prevent_secrets | Boolean | Definition: Whether to prevent committing secrets. Constraints: N/A. Value range: Default value: N/A. |
| deny_force_push | Boolean | Definition: Whether to disable forcible push. Constraints: N/A. Value range: Default value: N/A. |
Example Requests
None
Example Responses
Status code: 200
General commit rules of the repository.
{
"reject_unsigned_commits" : true,
"reject_not_signed_by_gpg" : true,
"deny_delete_tag" : true,
"prevent_secrets" : true,
"deny_force_push" : true
} Status Codes
| Status Code | Description |
|---|---|
| 200 | General commit rules of the repository. |
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.
