--- title: "Protected Branch Pull Request Review" url: "https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4/schemas/protected-branch-pull-request-review" --- > Full API specification: https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4.md # Protected Branch Pull Request Review Protected Branch Pull Request Review ## OpenAPI definition ```yaml openapi: 3.0.3 info: title: GitHub v3 REST API version: 1.1.4 servers: - url: "{protocol}://{hostname}/api/v3" variables: hostname: description: Self-hosted Enterprise Server or Enterprise Cloud hostname default: HOSTNAME protocol: description: Self-hosted Enterprise Server or Enterprise Cloud protocol default: http components: schemas: simple-user: title: Simple User description: Simple User type: object properties: name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url team: title: Team description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: type: integer node_id: type: string name: type: string slug: type: string description: type: string nullable: true privacy: type: string permission: type: string permissions: type: object properties: pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean admin: type: boolean required: - pull - triage - push - maintain - admin url: type: string format: uri html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core members_url: type: string repositories_url: type: string format: uri parent: $ref: "#/components/schemas/nullable-team-simple" required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug - parent nullable-team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: description: Unique identifier of the team type: integer example: 1 node_id: type: string example: MDQ6VGVhbTE= url: description: URL for the team type: string format: uri example: https://api.github.com/organizations/1/team/1 members_url: type: string example: https://api.github.com/organizations/1/team/1/members{/member} name: description: Name of the team type: string example: Justice League description: description: Description of the team type: string nullable: true example: A great team. permission: description: Permission that the team will have for its repositories type: string example: admin privacy: description: The level of privacy this team should have type: string example: closed html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core repositories_url: type: string format: uri example: https://api.github.com/organizations/1/team/1/repos slug: type: string example: justice-league ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug nullable: true 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" 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"' dismiss_stale_reviews: type: boolean example: true require_code_owner_reviews: type: boolean example: true required_approving_review_count: type: integer minimum: 1 maximum: 6 example: 2 required: - dismiss_stale_reviews - require_code_owner_reviews ```