Github API - Test Config

Flexydox

CreateBranchProtectionRuleInput [input]

Autogenerated input type of CreateBranchProtectionRule

Attributes
allowsDeletions Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can this branch be deleted.

allowsForcePushes Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Are force pushes allowed on this branch.

blocksCreations Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Is branch creation a protected operation.

bypassForcePushActorIds ID []

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.

bypassPullRequestActorIds ID []

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.

clientMutationId String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

A unique identifier for the client performing the mutation.

dismissesStaleReviews Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Will new commits pushed to matching branches dismiss pull request review approvals.

isAdminEnforced Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can admins override branch protection.

lockAllowsFetchAndMerge Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether users can pull changes from upstream when the branch is locked. Set to
true to allow fork syncing. Set to false to prevent fork syncing.

lockBranch Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

pattern String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The glob-like pattern used to determine matching branches.

pushActorIds ID []

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

A list of User, Team, or App IDs allowed to push to matching branches.

repositoryId ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

The global relay id of the repository in which a new branch protection rule should be created in.

requireLastPushApproval Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether the most recent push must be approved by someone other than the person who pushed it

requiredApprovingReviewCount Int

Int [scalar]

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

API:
Github GraphQL API

Number of approving reviews required to update matching branches.

requiredDeploymentEnvironments String []

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The list of required deployment environments

requiredStatusCheckContexts String []

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

List of required status check contexts that must pass for commits to be accepted to matching branches.

requiredStatusChecks RequiredStatusCheckInput []

RequiredStatusCheckInput [input]

Specifies the attributes for a new or updated required status check.

Attributes
appId ID

The ID of the App that must set the status in order for it to be accepted.
Omit this value to use whichever app has recently been setting this status, or
use "any" to allow any app to set the status.

context String

Status check context that must pass for commits to be accepted to the matching branch.

API:
Github GraphQL API

The list of required status checks

requiresApprovingReviews Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Are approving reviews required to update matching branches.

requiresCodeOwnerReviews Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Are reviews from code owners required to update matching branches.

requiresCommitSignatures Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Are commits required to be signed.

requiresConversationResolution Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Are conversations required to be resolved before merging.

requiresDeployments Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Are successful deployments required before merging.

requiresLinearHistory Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Are merge commits prohibited from being pushed to this branch.

requiresStatusChecks Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Are status checks required to update matching branches.

requiresStrictStatusChecks Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Are branches required to be up to date before merging.

restrictsPushes Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Is pushing to matching branches restricted.

restrictsReviewDismissals Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Is dismissal of pull request reviews restricted.

reviewDismissalActorIds ID []

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.

API:
Github GraphQL API