APIs.io Engineering Platform · Schema
Protected Branch Pull Request Review
Protected Branch Pull Request Review
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| url | string | |
| dismissal_restrictions | object | |
| bypass_pull_request_allowances | object | Allow specific users, teams, or apps to bypass pull request requirements. |
| dismiss_stale_reviews | boolean | |
| require_code_owner_reviews | boolean | |
| required_approving_review_count | integer | |
| require_last_push_approval | boolean | Whether the most recent push must be approved by someone other than the person who pushed it. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/protected-branch-pull-request-review",
"title": "Protected Branch Pull Request Review",
"description": "Protected Branch Pull Request Review",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions"
},
"dismissal_restrictions": {
"type": "object",
"properties": {
"users": {
"description": "The list of users with review dismissal access.",
"type": "array",
"items": {
"$ref": "#/components/schemas/simple-user"
}
},
"teams": {
"description": "The list of teams with review dismissal access.",
"type": "array",
"items": {
"$ref": "#/components/schemas/team"
}
},
"apps": {
"description": "The list of apps with review dismissal access.",
"type": "array",
"items": {
"$ref": "#/components/schemas/integration"
}
},
"url": {
"type": "string",
"example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\""
},
"users_url": {
"type": "string",
"example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\""
},
"teams_url": {
"type": "string",
"example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\""
}
}
},
"bypass_pull_request_allowances": {
"type": "object",
"description": "Allow specific users, teams, or apps to bypass pull request requirements.",
"properties": {
"users": {
"description": "The list of users allowed to bypass pull request requirements.",
"type": "array",
"items": {
"$ref": "#/components/schemas/simple-user"
}
},
"teams": {
"description": "The list of teams allowed to bypass pull request requirements.",
"type": "array",
"items": {
"$ref": "#/components/schemas/team"
}
},
"apps": {
"description": "The list of apps allowed to bypass pull request requirements.",
"type": "array",
"items": {
"$ref": "#/components/schemas/integration"
}
}
}
},
"dismiss_stale_reviews": {
"type": "boolean",
"example": true
},
"require_code_owner_reviews": {
"type": "boolean",
"example": true
},
"required_approving_review_count": {
"type": "integer",
"minimum": 0,
"maximum": 6,
"example": 2
},
"require_last_push_approval": {
"description": "Whether the most recent push must be approved by someone other than the person who pushed it.",
"type": "boolean",
"example": true,
"default": false
}
},
"required": [
"dismiss_stale_reviews",
"require_code_owner_reviews"
]
}