Github API - Test Config

Flexydox

BranchProtectionRule [object]

A branch protection rule.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
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.

branchProtectionRuleConflicts BranchProtectionRuleConflictConnection

BranchProtectionRuleConflictConnection [object]

The connection type for BranchProtectionRuleConflict.

Attributes
edges BranchProtectionRuleConflictEdge []

A list of edges.

nodes BranchProtectionRuleConflict []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

A list of conflicts matching branches protection rule and other branch protection rules

bypassForcePushAllowances BypassForcePushAllowanceConnection

BypassForcePushAllowanceConnection [object]

The connection type for BypassForcePushAllowance.

Attributes
edges BypassForcePushAllowanceEdge []

A list of edges.

nodes BypassForcePushAllowance []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

A list of actors able to force push for this branch protection rule.

bypassPullRequestAllowances BypassPullRequestAllowanceConnection

BypassPullRequestAllowanceConnection [object]

The connection type for BypassPullRequestAllowance.

Attributes
edges BypassPullRequestAllowanceEdge []

A list of edges.

nodes BypassPullRequestAllowance []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

A list of actors able to bypass PRs for this branch protection rule.

creator Actor

Actor [interface]

Represents an object which can take actions on GitHub. Typically a User or Bot.

Attributes
avatarUrl URI

A URL pointing to the actor's public avatar.

login String

The username of the actor.

resourcePath URI

The HTTP path for this actor.

url URI

The HTTP URL for this actor.

API:
Github GraphQL API

The actor who created this branch protection rule.

databaseId 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

Identifies the primary key from the database.

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.

id 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 Node ID of the BranchProtectionRule object

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.

matchingRefs RefConnection

RefConnection [object]

The connection type for Ref.

Attributes
edges RefEdge []

A list of edges.

nodes Ref []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

Repository refs that are protected by this rule

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

Identifies the protection rule pattern.

pushAllowances PushAllowanceConnection

PushAllowanceConnection [object]

The connection type for PushAllowance.

Attributes
edges PushAllowanceEdge []

A list of edges.

nodes PushAllowance []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

A list push allowances for this branch protection rule.

repository Repository

Repository [object]

A repository contains the content for a project.

Implements
NodePackageOwnerProjectOwnerProjectV2RecentRepositoryInfoStarrableSubscribableUniformResourceLocatable
Attributes
allowUpdateBranch Boolean

Whether or not a pull request head branch that is behind its base branch can
always be updated even if it is not required to be up to date before merging.

archivedAt DateTime

Identifies the date and time when the repository was archived.

assignableUsers UserConnection

A list of users that can be assigned to issues in this repository.

autoMergeAllowed Boolean

Whether or not Auto-merge can be enabled on pull requests in this repository.

branchProtectionRules BranchProtectionRuleConnection

A list of branch protection rules for this repository.

codeOfConduct CodeOfConduct

Returns the code of conduct for this repository

codeowners RepositoryCodeowners

Information extracted from the repository's CODEOWNERS file.

collaborators RepositoryCollaboratorConnection

A list of collaborators associated with the repository.

commitComments CommitCommentConnection

A list of commit comments associated with the repository.

contactLinks RepositoryContactLink []

Returns a list of contact links associated to the repository

contributingGuidelines ContributingGuidelines

Returns the contributing guidelines for this repository.

createdAt DateTime

Identifies the date and time when the object was created.

databaseId Int

Identifies the primary key from the database.

defaultBranchRef Ref

The Ref associated with the repository's default branch.

deleteBranchOnMerge Boolean

Whether or not branches are automatically deleted when merged in this repository.

dependencyGraphManifests DependencyGraphManifestConnection

A list of dependency manifests contained in the repository

deployKeys DeployKeyConnection

A list of deploy keys that are on this repository.

deployments DeploymentConnection

Deployments associated with the repository

description String

The description of the repository.

descriptionHTML HTML

The description of the repository rendered to HTML.

discussion Discussion

Returns a single discussion from the current repository by number.

discussionCategories DiscussionCategoryConnection

A list of discussion categories that are available in the repository.

discussionCategory DiscussionCategory

A discussion category by slug.

discussions DiscussionConnection

A list of discussions that have been opened in the repository.

diskUsage Int

The number of kilobytes this repository occupies on disk.

environment Environment

Returns a single active environment from the current repository by name.

environments EnvironmentConnection

A list of environments that are in this repository.

forkCount Int

Returns how many forks there are of this repository in the whole network.

forkingAllowed Boolean

Whether this repository allows forks.

forks RepositoryConnection

A list of direct forked repositories.

fundingLinks FundingLink []

The funding links for this repository

hasDiscussionsEnabled Boolean

Indicates if the repository has the Discussions feature enabled.

hasIssuesEnabled Boolean

Indicates if the repository has issues feature enabled.

hasProjectsEnabled Boolean

Indicates if the repository has the Projects feature enabled.

hasSponsorshipsEnabled Boolean

Indicates if the repository displays a Sponsor button for financial contributions.

hasVulnerabilityAlertsEnabled Boolean

Whether vulnerability alerts are enabled for the repository.

hasWikiEnabled Boolean

Indicates if the repository has wiki feature enabled.

homepageUrl URI

The repository's URL.

id ID

The Node ID of the Repository object

interactionAbility RepositoryInteractionAbility

The interaction ability settings for this repository.

isArchived Boolean

Indicates if the repository is unmaintained.

isBlankIssuesEnabled Boolean

Returns true if blank issue creation is allowed

isDisabled Boolean

Returns whether or not this repository disabled.

isEmpty Boolean

Returns whether or not this repository is empty.

isFork Boolean

Identifies if the repository is a fork.

isInOrganization Boolean

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

isLocked Boolean

Indicates if the repository has been locked or not.

isMirror Boolean

Identifies if the repository is a mirror.

isPrivate Boolean

Identifies if the repository is private or internal.

isSecurityPolicyEnabled Boolean

Returns true if this repository has a security policy

isTemplate Boolean

Identifies if the repository is a template that can be used to generate new repositories.

isUserConfigurationRepository Boolean

Is this repository a user configuration repository?

issue Issue

Returns a single issue from the current repository by number.

issueOrPullRequest IssueOrPullRequest

Returns a single issue-like object from the current repository by number.

issueTemplates IssueTemplate []

Returns a list of issue templates associated to the repository

issues IssueConnection

A list of issues that have been opened in the repository.

label Label

Returns a single label by name

labels LabelConnection

A list of labels associated with the repository.

languages LanguageConnection

A list containing a breakdown of the language composition of the repository.

latestRelease Release

Get the latest release for the repository if one exists.

licenseInfo License

The license associated with the repository

lockReason RepositoryLockReason

The reason the repository has been locked.

mentionableUsers UserConnection

A list of Users that can be mentioned in the context of the repository.

mergeCommitAllowed Boolean

Whether or not PRs are merged with a merge commit on this repository.

mergeCommitMessage MergeCommitMessage

How the default commit message will be generated when merging a pull request.

mergeCommitTitle MergeCommitTitle

How the default commit title will be generated when merging a pull request.

mergeQueue MergeQueue

The merge queue for a specified branch, otherwise the default branch if not provided.

milestone Milestone

Returns a single milestone from the current repository by number.

milestones MilestoneConnection

A list of milestones associated with the repository.

mirrorUrl URI

The repository's original mirror URL.

name String

The name of the repository.

nameWithOwner String

The repository's name with owner.

object GitObject

A Git object in the repository

openGraphImageUrl URI

The image used to represent this repository in Open Graph data.

owner RepositoryOwner

The User owner of the repository.

packages PackageConnection

A list of packages under the owner.

parent Repository

The repository parent, if this is a fork.

pinnedDiscussions PinnedDiscussionConnection

A list of discussions that have been pinned in this repository.

pinnedIssues PinnedIssueConnection

A list of pinned issues for this repository.

primaryLanguage Language

The primary language of the repository's code.

project Project

Find project by number.

projectV2 ProjectV2

Finds and returns the Project according to the provided Project number.

projects ProjectConnection

A list of projects under the owner.

projectsResourcePath URI

The HTTP path listing the repository's projects

projectsUrl URI

The HTTP URL listing the repository's projects

projectsV2 ProjectV2Connection

List of projects linked to this repository.

pullRequest PullRequest

Returns a single pull request from the current repository by number.

pullRequestTemplates PullRequestTemplate []

Returns a list of pull request templates associated to the repository

pullRequests PullRequestConnection

A list of pull requests that have been opened in the repository.

pushedAt DateTime

Identifies the date and time when the repository was last pushed to.

rebaseMergeAllowed Boolean

Whether or not rebase-merging is enabled on this repository.

recentProjects ProjectV2Connection

Recent projects that this user has modified in the context of the owner.

ref Ref

Fetch a given ref from the repository

refs RefConnection

Fetch a list of refs from the repository

release Release

Lookup a single release given various criteria.

releases ReleaseConnection

List of releases which are dependent on this repository.

repositoryTopics RepositoryTopicConnection

A list of applied repository-topic associations for this repository.

resourcePath URI

The HTTP path for this repository

ruleset RepositoryRuleset

Returns a single ruleset from the current repository by ID.

rulesets RepositoryRulesetConnection

A list of rulesets for this repository.

securityPolicyUrl URI

The security policy URL.

shortDescriptionHTML HTML

A description of the repository, rendered to HTML without any links in it.

squashMergeAllowed Boolean

Whether or not squash-merging is enabled on this repository.

squashMergeCommitMessage SquashMergeCommitMessage

How the default commit message will be generated when squash merging a pull request.

squashMergeCommitTitle SquashMergeCommitTitle

How the default commit title will be generated when squash merging a pull request.

squashPrTitleUsedAsDefault Boolean

Whether a squash merge commit can use the pull request title as default.

Deprecated: `squashPrTitleUsedAsDefault` will be removed. Use `Repository.squashMergeCommitTitle` instead. Removal on 2023-04-01 UTC.
sshUrl GitSSHRemote

The SSH URL to clone this repository

stargazerCount Int

Returns a count of how many stargazers there are on this object

stargazers StargazerConnection

A list of users who have starred this starrable.

submodules SubmoduleConnection

Returns a list of all submodules in this repository parsed from the
.gitmodules file as of the default branch's HEAD commit.

tempCloneToken String

Temporary authentication token for cloning this repository.

templateRepository Repository

The repository from which this repository was generated, if any.

updatedAt DateTime

Identifies the date and time when the object was last updated.

url URI

The HTTP URL for this repository

usesCustomOpenGraphImage Boolean

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

viewerCanAdminister Boolean

Indicates whether the viewer has admin permissions on this repository.

viewerCanCreateProjects Boolean

Can the current viewer create new projects on this owner.

viewerCanSubscribe Boolean

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdateTopics Boolean

Indicates whether the viewer can update the topics of this repository.

viewerDefaultCommitEmail String

The last commit email for the viewer.

viewerDefaultMergeMethod PullRequestMergeMethod

The last used merge method by the viewer or the default for the repository.

viewerHasStarred Boolean

Returns a boolean indicating whether the viewing user has starred this starrable.

viewerPermission RepositoryPermission

The users permission level on the repository. Will return null if authenticated as an GitHub App.

viewerPossibleCommitEmails String []

A list of emails this viewer can commit with.

viewerSubscription SubscriptionState

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

visibility RepositoryVisibility

Indicates the repository's visibility level.

vulnerabilityAlert RepositoryVulnerabilityAlert

Returns a single vulnerability alert from the current repository by number.

vulnerabilityAlerts RepositoryVulnerabilityAlertConnection

A list of vulnerability alerts that are on this repository.

watchers UserConnection

A list of users watching the repository.

webCommitSignoffRequired Boolean

Whether contributors are required to sign off on web-based commits in this repository.

API:
Github GraphQL API

The repository associated with this branch protection rule.

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

List of required deployment environments that must be deployed successfully to update matching branches

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 RequiredStatusCheckDescription []

RequiredStatusCheckDescription [object]

Represents a required status check for a protected branch, but not any specific run of that check.

Attributes
app App

The App that must provide this status in order for it to be accepted.

context String

The name of this status.

API:
Github GraphQL API

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

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

Does this branch require deployment to specific environments 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.

reviewDismissalAllowances ReviewDismissalAllowanceConnection

ReviewDismissalAllowanceConnection [object]

The connection type for ReviewDismissalAllowance.

Attributes
edges ReviewDismissalAllowanceEdge []

A list of edges.

nodes ReviewDismissalAllowance []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

A list review dismissal allowances for this branch protection rule.

API:
Github GraphQL API