Objects

Objects in GraphQL represent the resources you can access.

In this article

About objects

Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.

For example, the Repository object has a field called name, which is a String.

For more information, see Introduction to GraphQL.

ActorConnection

The connection type for Actor.

Fields for ActorConnection

NameDescription

edges ([ActorEdge])

A list of edges.

nodes ([Actor])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ActorEdge

An edge in a connection.

Fields for ActorEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Actor)

The item at the end of the edge.

ActorLocation

Location information for an actor.

Fields for ActorLocation

NameDescription

city (String)

City.

country (String)

Country name.

countryCode (String)

Country code.

region (String)

Region name.

regionCode (String)

Region or state code.

AddedToMergeQueueEvent

Represents anadded_to_merge_queueevent on a given pull request.

AddedToMergeQueueEvent Implements

Fields for AddedToMergeQueueEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enqueuer (User)

The user who added this Pull Request to the merge queue.

id (ID!)

The Node ID of the AddedToMergeQueueEvent object.

mergeQueue (MergeQueue)

The merge queue where this pull request was added to.

pullRequest (PullRequest)

PullRequest referenced by event.

AddedToProjectEvent

Represents aadded_to_projectevent on a given issue or pull request.

AddedToProjectEvent Implements

Fields for AddedToProjectEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

Warning

databaseId is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

id (ID!)

The Node ID of the AddedToProjectEvent object.

project (Project)

Project referenced by event.

Warning

project is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

projectCard (ProjectCard)

Project card referenced by this project event.

Warning

projectCard is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

projectColumnName (String!)

Column name referenced by this project event.

Warning

projectColumnName is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

AnnouncementBanner

An announcement banner for an enterprise or organization.

Fields for AnnouncementBanner

NameDescription

createdAt (DateTime!)

The date the announcement was created.

expiresAt (DateTime)

The expiration date of the announcement, if any.

isUserDismissible (Boolean!)

Whether the announcement can be dismissed by the user.

message (String)

The text of the announcement.

App

A GitHub App.

App Implements

Fields for App

NameDescription

clientId (String)

The client ID of the app.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The description of the app.

id (ID!)

The Node ID of the App object.

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses of the app.

Arguments for ipAllowListEntries

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

logoUrl (URI!)

A URL pointing to the app's logo.

Arguments for logoUrl

  • size (Int)

    The size of the resulting image.

name (String!)

The name of the app.

slug (String!)

A slug based on the name of the app for use in URLs.

updatedAt (DateTime!)

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

url (URI!)

The URL to the app's homepage.

AssignedEvent

Represents anassignedevent on any assignable object.

AssignedEvent Implements

Fields for AssignedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

assignable (Assignable!)

Identifies the assignable associated with the event.

assignee (Assignee)

Identifies the user or mannequin that was assigned.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AssignedEvent object.

user (User)

Identifies the user who was assigned.

Warning

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

AssigneeConnection

The connection type for Assignee.

Fields for AssigneeConnection

NameDescription

edges ([AssigneeEdge])

A list of edges.

nodes ([Assignee])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

AssigneeEdge

An edge in a connection.

Fields for AssigneeEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Assignee)

The item at the end of the edge.

AutoMergeDisabledEvent

Represents aauto_merge_disabledevent on a given pull request.

AutoMergeDisabledEvent Implements

Fields for AutoMergeDisabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

disabler (User)

The user who disabled auto-merge for this Pull Request.

id (ID!)

The Node ID of the AutoMergeDisabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

reason (String)

The reason auto-merge was disabled.

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

AutoMergeEnabledEvent

Represents aauto_merge_enabledevent on a given pull request.

AutoMergeEnabledEvent Implements

Fields for AutoMergeEnabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge for this Pull Request.

id (ID!)

The Node ID of the AutoMergeEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

AutoMergeRequest

Represents an auto-merge request for a pull request.

Fields for AutoMergeRequest

NameDescription

authorEmail (String)

The email address of the author of this auto-merge request.

commitBody (String)

The commit message of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

commitHeadline (String)

The commit title of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

enabledAt (DateTime)

When was this auto-merge request was enabled.

enabledBy (Actor)

The actor who created the auto-merge request.

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

AutoRebaseEnabledEvent

Represents aauto_rebase_enabledevent on a given pull request.

AutoRebaseEnabledEvent Implements

Fields for AutoRebaseEnabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

id (ID!)

The Node ID of the AutoRebaseEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

AutoSquashEnabledEvent

Represents aauto_squash_enabledevent on a given pull request.

AutoSquashEnabledEvent Implements

Fields for AutoSquashEnabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

id (ID!)

The Node ID of the AutoSquashEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

AutomaticBaseChangeFailedEvent

Represents aautomatic_base_change_failedevent on a given pull request.

AutomaticBaseChangeFailedEvent Implements

Fields for AutomaticBaseChangeFailedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AutomaticBaseChangeFailedEvent object.

newBase (String!)

The new base for this PR.

oldBase (String!)

The old base for this PR.

pullRequest (PullRequest!)

PullRequest referenced by event.

AutomaticBaseChangeSucceededEvent

Represents aautomatic_base_change_succeededevent on a given pull request.

AutomaticBaseChangeSucceededEvent Implements

Fields for AutomaticBaseChangeSucceededEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AutomaticBaseChangeSucceededEvent object.

newBase (String!)

The new base for this PR.

oldBase (String!)

The old base for this PR.

pullRequest (PullRequest!)

PullRequest referenced by event.

BaseRefChangedEvent

Represents abase_ref_changedevent on a given issue or pull request.

BaseRefChangedEvent Implements

Fields for BaseRefChangedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the BaseRefChangedEvent object.

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

pullRequest (PullRequest!)

PullRequest referenced by event.

BaseRefDeletedEvent

Represents abase_ref_deletedevent on a given pull request.

BaseRefDeletedEvent Implements

Fields for BaseRefDeletedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BaseRefDeletedEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

BaseRefForcePushedEvent

Represents abase_ref_force_pushedevent on a given pull request.

BaseRefForcePushedEvent Implements

Fields for BaseRefForcePushedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BaseRefForcePushedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

Blame

Represents a Git blame.

Fields for Blame

NameDescription

ranges ([BlameRange!]!)

The list of ranges from a Git blame.

BlameRange

Represents a range of information from a Git blame.

Fields for BlameRange

NameDescription

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is calculated as a 2-quantile and determines the length of distance between the median age of all the changes in the file and the recency of the current range's change.

commit (Commit!)

Identifies the line author.

endingLine (Int!)

The ending line for the range.

startingLine (Int!)

The starting line for the range.

Blob

Represents a Git blob.

Blob Implements

Fields for Blob

NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

byteSize (Int!)

Byte size of Blob object.

commitResourcePath (URI!)

The HTTP path for this Git object.

commitUrl (URI!)

The HTTP URL for this Git object.

id (ID!)

The Node ID of the Blob object.

isBinary (Boolean)

Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

isTruncated (Boolean!)

Indicates whether the contents is truncated.

oid (GitObjectID!)

The Git object ID.

repository (Repository!)

The Repository the Git object belongs to.

text (String)

UTF8 text data or null if the Blob is binary.

BlockedByAddedEvent

Represents ablocked_by_addedevent on a given issue.

BlockedByAddedEvent Implements

Fields for BlockedByAddedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

blockingIssue (Issue)

The blocking issue that was added.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BlockedByAddedEvent object.

BlockedByRemovedEvent

Represents ablocked_by_removedevent on a given issue.

BlockedByRemovedEvent Implements

Fields for BlockedByRemovedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

blockingIssue (Issue)

The blocking issue that was removed.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BlockedByRemovedEvent object.

BlockingAddedEvent

Represents ablocking_addedevent on a given issue.

BlockingAddedEvent Implements

Fields for BlockingAddedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

blockedIssue (Issue)

The blocked issue that was added.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BlockingAddedEvent object.

BlockingRemovedEvent

Represents ablocking_removedevent on a given issue.

BlockingRemovedEvent Implements

Fields for BlockingRemovedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

blockedIssue (Issue)

The blocked issue that was removed.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BlockingRemovedEvent object.

Bot

A special type of user which takes actions on behalf of GitHub Apps.

Bot Implements

Fields for Bot

NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

Arguments for avatarUrl

  • size (Int)

    The size of the resulting square image.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the Bot object.

login (String!)

The username of the actor.

resourcePath (URI!)

The HTTP path for this bot.

updatedAt (DateTime!)

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

url (URI!)

The HTTP URL for this bot.

BranchNamePatternParameters

Parameters to be used for the branch_name_pattern rule.

Fields for BranchNamePatternParameters

NameDescription

name (String)

How this rule will appear to users.

negate (Boolean!)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

BranchProtectionRule

A branch protection rule.

BranchProtectionRule Implements

Fields for BranchProtectionRule

NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

blocksCreations (Boolean!)

Is branch creation a protected operation.

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

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

Arguments for branchProtectionRuleConflicts

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

bypassForcePushAllowances (BypassForcePushAllowanceConnection!)

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

Arguments for bypassForcePushAllowances

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

bypassPullRequestAllowances (BypassPullRequestAllowanceConnection!)

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

Arguments for bypassPullRequestAllowances

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

creator (Actor)

The actor who created this branch protection rule.

databaseId (Int)

Identifies the primary key from the database.

dismissesStaleReviews (Boolean!)

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

id (ID!)

The Node ID of the BranchProtectionRule object.

isAdminEnforced (Boolean!)

Can admins override branch protection.

lockAllowsFetchAndMerge (Boolean!)

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!)

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

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

Arguments for matchingRefs

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    Filters refs with query on name.

pattern (String!)

Identifies the protection rule pattern.

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

Arguments for pushAllowances

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

repository (Repository)

The repository associated with this branch protection rule.

requireLastPushApproval (Boolean!)

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

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

requiredDeploymentEnvironments ([String])

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

requiredStatusCheckContexts ([String])

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

requiredStatusChecks ([RequiredStatusCheckDescription!])

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

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

requiresConversationResolution (Boolean!)

Are conversations required to be resolved before merging.

requiresDeployments (Boolean!)

Does this branch require deployment to specific environments before merging.

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

Arguments for reviewDismissalAllowances

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

BranchProtectionRuleConflict

A conflict between two branch protection rules.

Fields for BranchProtectionRuleConflict

NameDescription

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

ref (Ref)

Identifies the branch ref that has conflicting rules.

BranchProtectionRuleConflictConnection

The connection type for BranchProtectionRuleConflict.

Fields for BranchProtectionRuleConflictConnection

NameDescription

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.

BranchProtectionRuleConflictEdge

An edge in a connection.

Fields for BranchProtectionRuleConflictEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (BranchProtectionRuleConflict)

The item at the end of the edge.

BranchProtectionRuleConnection

The connection type for BranchProtectionRule.

Fields for BranchProtectionRuleConnection

NameDescription

edges ([BranchProtectionRuleEdge])

A list of edges.

nodes ([BranchProtectionRule])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

BranchProtectionRuleEdge

An edge in a connection.

Fields for BranchProtectionRuleEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (BranchProtectionRule)

The item at the end of the edge.

BypassForcePushAllowance

A user, team, or app who has the ability to bypass a force push requirement on a protected branch.

BypassForcePushAllowance Implements

Fields for BypassForcePushAllowance

NameDescription

actor (BranchActorAllowanceActor)

The actor that can force push.

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user, team, or app.

id (ID!)

The Node ID of the BypassForcePushAllowance object.

BypassForcePushAllowanceConnection

The connection type for BypassForcePushAllowance.

Fields for BypassForcePushAllowanceConnection

NameDescription

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.

BypassForcePushAllowanceEdge

An edge in a connection.

Fields for BypassForcePushAllowanceEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (BypassForcePushAllowance)

The item at the end of the edge.

BypassPullRequestAllowance

A user, team, or app who has the ability to bypass a pull request requirement on a protected branch.

BypassPullRequestAllowance Implements

Fields for BypassPullRequestAllowance

NameDescription

actor (BranchActorAllowanceActor)

The actor that can bypass.

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user, team, or app.

id (ID!)

The Node ID of the BypassPullRequestAllowance object.

BypassPullRequestAllowanceConnection

The connection type for BypassPullRequestAllowance.

Fields for BypassPullRequestAllowanceConnection

NameDescription

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.

BypassPullRequestAllowanceEdge

An edge in a connection.

Fields for BypassPullRequestAllowanceEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (BypassPullRequestAllowance)

The item at the end of the edge.

CVSS

The Common Vulnerability Scoring System.

Fields for CVSS

NameDescription

score (Float!)

The CVSS score associated with this advisory.

vectorString (String)

The CVSS vector string associated with this advisory.

CWE

A common weakness enumeration.

CWE Implements

Fields for CWE

NameDescription

cweId (String!)

The id of the CWE.

description (String!)

A detailed description of this CWE.

id (ID!)

The Node ID of the CWE object.

name (String!)

The name of this CWE.

CWEConnection

The connection type for CWE.

Fields for CWEConnection

NameDescription

edges ([CWEEdge])

A list of edges.

nodes ([CWE])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CWEEdge

An edge in a connection.

Fields for CWEEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CWE)

The item at the end of the edge.

CheckAnnotation

A single check annotation.

Fields for CheckAnnotation

NameDescription

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

blobUrl (URI!)

The path to the file that this annotation was made on.

databaseId (Int)

Identifies the primary key from the database.

location (CheckAnnotationSpan!)

The position of this annotation.

message (String!)

The annotation's message.

path (String!)

The path that this annotation was made on.

rawDetails (String)

Additional information about the annotation.

title (String)

The annotation's title.

CheckAnnotationConnection

The connection type for CheckAnnotation.

Fields for CheckAnnotationConnection

NameDescription

edges ([CheckAnnotationEdge])

A list of edges.

nodes ([CheckAnnotation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckAnnotationEdge

An edge in a connection.

Fields for CheckAnnotationEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CheckAnnotation)

The item at the end of the edge.

CheckAnnotationPosition

A character position in a check annotation.

Fields for CheckAnnotationPosition

NameDescription

column (Int)

Column number (1 indexed).

line (Int!)

Line number (1 indexed).

CheckAnnotationSpan

An inclusive pair of positions for a check annotation.

Fields for CheckAnnotationSpan

NameDescription

end (CheckAnnotationPosition!)

End position (inclusive).

start (CheckAnnotationPosition!)

Start position (inclusive).

CheckRun

A check run.

CheckRun Implements

Fields for CheckRun

NameDescription

annotations (CheckAnnotationConnection)

The check run's annotations.

Arguments for annotations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

checkSuite (CheckSuite!)

The check suite that this run is a part of.

completedAt (DateTime)

Identifies the date and time when the check run was completed.

conclusion (CheckConclusionState)

The conclusion of the check run.

databaseId (Int)

Identifies the primary key from the database.

deployment (Deployment)

The corresponding deployment for this job, if any.

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

externalId (String)

A reference for the check run on the integrator's system.

id (ID!)

The Node ID of the CheckRun object.

isRequired (Boolean!)

Whether this is required to pass before merging for a specific pull request.

Arguments for isRequired

  • pullRequestId (ID)

    The id of the pull request this is required for.

  • pullRequestNumber (Int)

    The number of the pull request this is required for.

name (String!)

The name of the check for this check run.

pendingDeploymentRequest (DeploymentRequest)

Information about a pending deployment, if any, in this check run.

permalink (URI!)

The permalink to the check run summary.

repository (Repository!)

The repository associated with this check run.

resourcePath (URI!)

The HTTP path for this check run.

startedAt (DateTime)

Identifies the date and time when the check run was started.

status (CheckStatusState!)

The current status of the check run.

steps (CheckStepConnection)

The check run's steps.

Arguments for steps

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • number (Int)

    Step number.

summary (String)

A string representing the check run's summary.

text (String)

A string representing the check run's text.

title (String)

A string representing the check run.

url (URI!)

The HTTP URL for this check run.

CheckRunConnection

The connection type for CheckRun.

Fields for CheckRunConnection

NameDescription

edges ([CheckRunEdge])

A list of edges.

nodes ([CheckRun])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckRunEdge

An edge in a connection.

Fields for CheckRunEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CheckRun)

The item at the end of the edge.

CheckRunStateCount

Represents a count of the state of a check run.

Fields for CheckRunStateCount

NameDescription

count (Int!)

The number of check runs with this state.

state (CheckRunState!)

The state of a check run.

CheckStep

A single check step.

Fields for CheckStep

NameDescription

completedAt (DateTime)

Identifies the date and time when the check step was completed.

conclusion (CheckConclusionState)

The conclusion of the check step.

externalId (String)

A reference for the check step on the integrator's system.

name (String!)

The step's name.

number (Int!)

The index of the step in the list of steps of the parent check run.

secondsToCompletion (Int)

Number of seconds to completion.

startedAt (DateTime)

Identifies the date and time when the check step was started.

status (CheckStatusState!)

The current status of the check step.

CheckStepConnection

The connection type for CheckStep.

Fields for CheckStepConnection

NameDescription

edges ([CheckStepEdge])

A list of edges.

nodes ([CheckStep])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckStepEdge

An edge in a connection.

Fields for CheckStepEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CheckStep)

The item at the end of the edge.

CheckSuite

A check suite.

CheckSuite Implements

Fields for CheckSuite

NameDescription

app (App)

The GitHub App which created this check suite.

branch (Ref)

The name of the branch for this check suite.

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

Arguments for checkRuns

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

commit (Commit!)

The commit for this check suite.

conclusion (CheckConclusionState)

The conclusion of this check suite.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (User)

The user who triggered the check suite.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the CheckSuite object.

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

Arguments for matchingPullRequests

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • baseRefName (String)

    The base ref name to filter the pull requests by.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • headRefName (String)

    The head ref name to filter the pull requests by.

  • labels ([String!])

    A list of label names to filter the pull requests by.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (IssueOrder)

    Ordering options for pull requests returned from the connection.

push (Push)

The push that triggered this check suite.

repository (Repository!)

The repository associated with this check suite.

resourcePath (URI!)

The HTTP path for this check suite.

status (CheckStatusState!)

The status of this check suite.

updatedAt (DateTime!)

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

url (URI!)

The HTTP URL for this check suite.

workflowRun (WorkflowRun)

The workflow run associated with this check suite.

CheckSuiteConnection

The connection type for CheckSuite.

Fields for CheckSuiteConnection

NameDescription

edges ([CheckSuiteEdge])

A list of edges.

nodes ([CheckSuite])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckSuiteEdge

An edge in a connection.

Fields for CheckSuiteEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (CheckSuite)

The item at the end of the edge.

ClosedEvent

Represents aclosedevent on any Closable.

ClosedEvent Implements

Fields for ClosedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

closable (Closable!)

Object that was closed.

closer (Closer)

Object which triggered the creation of this event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

duplicateOf (IssueOrPullRequest)

The issue or pull request that this issue was marked as a duplicate of.

id (ID!)

The Node ID of the ClosedEvent object.

resourcePath (URI!)

The HTTP path for this closed event.

stateReason (IssueStateReason)

The reason the issue state was changed to closed.

url (URI!)

The HTTP URL for this closed event.

CodeOfConduct

The Code of Conduct for a repository.

CodeOfConduct Implements

Fields for CodeOfConduct

NameDescription

body (String)

The body of the Code of Conduct.

id (ID!)

The Node ID of the CodeOfConduct object.

key (String!)

The key for the Code of Conduct.

name (String!)

The formal name of the Code of Conduct.

resourcePath (URI)

The HTTP path for this Code of Conduct.

url (URI)

The HTTP URL for this Code of Conduct.

CodeScanningParameters

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

Fields for CodeScanningParameters

NameDescription

codeScanningTools ([CodeScanningTool!]!)

Tools that must provide code scanning results for this rule to pass.

CodeScanningTool

A tool that must provide code scanning results for this rule to pass.

Fields for CodeScanningTool

NameDescription

alertsThreshold (String!)

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts.".

securityAlertsThreshold (String!)

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts.".

tool (String!)

The name of a code scanning tool.

CommentDeletedEvent

Represents acomment_deletedevent on a given issue or pull request.

CommentDeletedEvent Implements

Fields for CommentDeletedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

deletedCommentAuthor (Actor)

The user who authored the deleted comment.

id (ID!)

The Node ID of the CommentDeletedEvent object.

Commit

Represents a Git commit.

Commit Implements

Fields for Commit

NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

additions (Int!)

The number of additions in this commit.

associatedPullRequests (PullRequestConnection)

The merged Pull Request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open Pull Requests associated with the commit.

Arguments for associatedPullRequests

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (