TeamUsageBranchRule
A protected-branch rule that lets the team push or merge below the rule's minimum role.
Shape
atAccessScopeThe group or repository the rule protects branches of.
- The AccessScope schema
- full_pathstring
- idstring
- typeScopeTypegrouprepository
- branch_patternBranchPattern (string)
- branch_rule_idBranchRuleId (string · uuid)
- mergebooleanWhether the team may merge into them.
- pushbooleanWhether the team may push to the branches the rule protects.
Example
Synthesized example{
"at": {
"full_path": "acme/payments-api",
"id": "id-555b",
"type": "group"
},
"branch_pattern": "branch-pattern-b7ed",
"branch_rule_id": "67d55c8e-e368-4374-9800-42d4a54f5832",
"merge": false,
"push": false
}
Graph
Used inside
Contains
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 0 operations
No operation returns it directly.