Schema1.1.4object

protected-branch

Branch protections protect branches

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Protected Branch

object

Branch protections protect branches

allow_deletions object

optional

allow_force_pushes object

optional

enforce_admins object

optional

required_conversation_resolution object

optional

required_linear_history object

optional

required_pull_request_reviews object

optional

required_signatures object

optional

required_status_checks Status Check Policy object

optional

restrictions Branch Restriction Policy object

optional

url string (uri)

required

Root JSON Schema

{"description":"Branch protections protect branches","properties":{"allow_deletions":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"allow_force_pushes":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"enforce_admins":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"url":{"format":"uri","type":"string"}},"required":["url","enabled"],"type":"object"},"required_conversation_resolution":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"}},"type":"object"},"required_linear_history":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"required_pull_request_reviews":{"properties":{"dismiss_stale_reviews":{"type":"boolean"},"dismissal_restrictions":{"properties":{"teams":{"items":{"$ref":"#/components/schemas/team"},"type":"array"},"teams_url":{"format":"uri","type":"string"},"url":{"format":"uri","type":"string"},"users":{"items":{"$ref":"#/components/schemas/simple-user"},"type":"array"},"users_url":{"format":"uri","type":"string"}},"required":["url","users_url","teams_url","users","teams"],"type":"object"},"require_code_owner_reviews":{"type":"boolean"},"required_approving_review_count":{"type":"integer"},"url":{"format":"uri","type":"string"}},"required":["url"],"type":"object"},"required_signatures":{"properties":{"enabled":{"example":true,"type":"boolean"},"url":{"example":"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures","format":"uri","type":"string"}},"required":["url","enabled"],"type":"object"},"required_status_checks":{"$ref":"#/components/schemas/status-check-policy"},"restrictions":{"$ref":"#/components/schemas/branch-restriction-policy"},"url":{"format":"uri","type":"string"}},"required":["url"],"title":"Protected Branch","type":"object"}