Skip to main content

Objects

AcceptEnterpriseAdministratorInvitationPayload#

Autogenerated return type of AcceptEnterpriseAdministratorInvitation

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

invitation
EnterpriseAdministratorInvitation

The invitation that was accepted.

message
String

A message confirming the result of accepting an administrator invitation.

AcceptTopicSuggestionPayload#

Autogenerated return type of AcceptTopicSuggestion

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

topic
Topic

The accepted topic.

ActorLocation#

Location information for an actor

Fields

NameDescription
city
String

City

country
String

Country name

countryCode
String

Country code

region
String

Region name

regionCode
String

Region or state code

AddAssigneesToAssignablePayload#

Autogenerated return type of AddAssigneesToAssignable

Fields

NameDescription
assignable
Assignable

The item that was assigned.

clientMutationId
String

A unique identifier for the client performing the mutation.

AddCommentPayload#

Autogenerated return type of AddComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

commentEdge
IssueCommentEdge

The edge from the subject's comment connection.

subject
Node

The subject

timelineEdge
IssueTimelineItemEdge

The edge from the subject's timeline connection.

AddedToProjectEvent#

Represents a 'added_to_project' event on a given issue or pull request.

Implements

Fields

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.

id
ID!
project
Project

Project referenced by event.

projectCard
ProjectCard

Project card referenced by this project event.

projectColumnName
String!

Column name referenced by this project event.

AddEnterpriseSupportEntitlementPayload#

Autogenerated return type of AddEnterpriseSupportEntitlement

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

message
String

A message confirming the result of adding the support entitlement.

AddLabelsToLabelablePayload#

Autogenerated return type of AddLabelsToLabelable

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

labelable
Labelable

The item that was labeled.

AddProjectCardPayload#

Autogenerated return type of AddProjectCard

Fields

NameDescription
cardEdge
ProjectCardEdge

The edge from the ProjectColumn's card connection.

clientMutationId
String

A unique identifier for the client performing the mutation.

projectColumn
ProjectColumn

The ProjectColumn

AddProjectColumnPayload#

Autogenerated return type of AddProjectColumn

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

columnEdge
ProjectColumnEdge

The edge from the project's column connection.

project
Project

The project

AddPullRequestReviewCommentPayload#

Autogenerated return type of AddPullRequestReviewComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

comment
PullRequestReviewComment

The newly created comment.

commentEdge
PullRequestReviewCommentEdge

The edge from the review's comment connection.

AddPullRequestReviewPayload#

Autogenerated return type of AddPullRequestReview

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestReview
PullRequestReview

The newly created pull request review.

reviewEdge
PullRequestReviewEdge

The edge from the pull request's review connection.

AddPullRequestReviewThreadPayload#

Autogenerated return type of AddPullRequestReviewThread

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

thread
PullRequestReviewThread

The newly created thread.

AddReactionPayload#

Autogenerated return type of AddReaction

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

reaction
Reaction

The reaction object.

subject
Reactable

The reactable subject.

AddStarPayload#

Autogenerated return type of AddStar

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

starrable
Starrable

The starrable.

AddVerifiableDomainPayload#

Autogenerated return type of AddVerifiableDomain

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

domain
VerifiableDomain

The verifiable domain that was added.

App#

A GitHub App.

Implements

Fields

NameDescription
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!
logoBackgroundColor
String!

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

logoUrl
URI!

A URL pointing to the app's logo.

Arguments

NameDescription
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.

ApproveVerifiableDomainPayload#

Autogenerated return type of ApproveVerifiableDomain

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

domain
VerifiableDomain

The verifiable domain that was approved.

ArchiveRepositoryPayload#

Autogenerated return type of ArchiveRepository

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repository
Repository

The repository that was marked as archived.

AssignedEvent#

Represents an 'assigned' event on any assignable object.

Implements

Fields

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!
user
User
Deprecated: Assignees can now be mannequins. Use the `assignee` field instead. Removal on 2020-01-01 UTC.

Identifies the user who was assigned.

AutomaticBaseChangeFailedEvent#

Represents a 'automatic_base_change_failed' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
newBase
String!

The new base for this PR

oldBase
String!

The old base for this PR

pullRequest
PullRequest!

PullRequest referenced by event.

AutomaticBaseChangeSucceededEvent#

Represents a 'automatic_base_change_succeeded' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
newBase
String!

The new base for this PR

oldBase
String!

The old base for this PR

pullRequest
PullRequest!

PullRequest referenced by event.

AutoMergeDisabledEvent#

Represents a 'auto_merge_disabled' event on a given pull request.

Implements

Fields

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!
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 a 'auto_merge_enabled' event on a given pull request.

Implements

Fields

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!
pullRequest
PullRequest

PullRequest referenced by event.

AutoMergeRequest#

Represents an auto-merge request for a pull request

Fields

NameDescription
authorEmail
String

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

commitBody
String

The commit message of the auto-merge request.

commitHeadline
String

The commit title of the auto-merge request.

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.

pullRequest
PullRequest!

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

AutoRebaseEnabledEvent#

Represents a 'auto_rebase_enabled' event on a given pull request.

Implements

Fields

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!
pullRequest
PullRequest

PullRequest referenced by event.

AutoSquashEnabledEvent#

Represents a 'auto_squash_enabled' event on a given pull request.

Implements

Fields

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!
pullRequest
PullRequest

PullRequest referenced by event.

BaseRefChangedEvent#

Represents a 'base_ref_changed' event on a given issue or pull request.

Implements

Fields

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!
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 a 'base_ref_deleted' event on a given pull request.

Implements

Fields

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!
pullRequest
PullRequest

PullRequest referenced by event.

BaseRefForcePushedEvent#

Represents a 'base_ref_force_pushed' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

afterCommit
Commit

Identifies the after commit SHA for the 'base_ref_force_pushed' event.

beforeCommit
Commit

Identifies the before commit SHA for the 'base_ref_force_pushed' event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

ref
Ref

Identifies the fully qualified ref name for the 'base_ref_force_pushed' event.

Blame#

Represents a Git blame.

Fields

NameDescription
ranges
[BlameRange!]!

The list of ranges from a Git blame.

BlameRange#

Represents a range of information from a Git blame.

Fields

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.

Implements

Fields

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

Bot#

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

Implements

Fields

NameDescription
avatarUrl
URI!

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

Arguments

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

BranchProtectionRule#

A branch protection rule.

Implements

Fields

NameDescription
allowsDeletions
Boolean!

Can this branch be deleted.

allowsForcePushes
Boolean!

Are force pushes allowed on this branch.

branchProtectionRuleConflicts
BranchProtectionRuleConflictConnection!

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

Arguments

NameDescription
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!
isAdminEnforced
Boolean!

Can admins overwrite branch protection.

matchingRefs
RefConnection!

Repository refs that are protected by this rule

Arguments

NameDescription
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

NameDescription
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.

requiredApprovingReviewCount
Int

Number of approving reviews required to update matching branches.

requiredStatusCheckContexts
[String]

List of required status check contexts 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.

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

NameDescription
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

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

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

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

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

NameDescription
cursor
String!

A cursor for use in pagination.

node
BranchProtectionRule

The item at the end of the edge.

CancelEnterpriseAdminInvitationPayload#

Autogenerated return type of CancelEnterpriseAdminInvitation

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

invitation
EnterpriseAdministratorInvitation

The invitation that was canceled.

message
String

A message confirming the result of canceling an administrator invitation.

ChangeUserStatusPayload#

Autogenerated return type of ChangeUserStatus

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

status
UserStatus

Your updated status.

CheckAnnotation#

A single check annotation.

Fields

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

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

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

NameDescription
column
Int

Column number (1 indexed).

line
Int!

Line number (1 indexed).

CheckAnnotationSpan#

An inclusive pair of positions for a check annotation.

Fields

NameDescription
end
CheckAnnotationPosition!

End position (inclusive).

start
CheckAnnotationPosition!

Start position (inclusive).

CheckRun#

A check run.

Implements

Fields

NameDescription
annotations
CheckAnnotationConnection

The check run's annotations

Arguments

NameDescription
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.

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!
isRequired
Boolean!

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

Arguments

NameDescription
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.

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.

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

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

NameDescription
cursor
String!

A cursor for use in pagination.

node
CheckRun

The item at the end of the edge.

CheckSuite#

A check suite.

Implements

Fields

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

NameDescription
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.

filterBy
CheckRunFilter

Filters the check runs by this type.

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.

databaseId
Int

Identifies the primary key from the database.

id
ID!
matchingPullRequests
PullRequestConnection

A list of open pull requests matching the check suite.

Arguments

NameDescription
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.

states
[PullRequestState!]

A list of states to filter the pull requests by.

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

CheckSuiteConnection#

The connection type for CheckSuite.

Fields

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

NameDescription
cursor
String!

A cursor for use in pagination.

node
CheckSuite

The item at the end of the edge.

ClearLabelsFromLabelablePayload#

Autogenerated return type of ClearLabelsFromLabelable

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

labelable
Labelable

The item that was unlabeled.

CloneProjectPayload#

Autogenerated return type of CloneProject

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

jobStatusId
String

The id of the JobStatus for populating cloned fields.

project
Project

The new cloned project.

CloneTemplateRepositoryPayload#

Autogenerated return type of CloneTemplateRepository

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repository
Repository

The new repository.

ClosedEvent#

Represents a 'closed' event on any Closable.

Implements

Fields

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.

id
ID!
resourcePath
URI!

The HTTP path for this closed event.

url
URI!

The HTTP URL for this closed event.

CloseIssuePayload#

Autogenerated return type of CloseIssue

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issue
Issue

The issue that was closed.

ClosePullRequestPayload#

Autogenerated return type of ClosePullRequest

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The pull request that was closed.

CodeOfConduct#

The Code of Conduct for a repository

Implements

Fields

NameDescription
body
String

The body of the Code of Conduct

id
ID!
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

CommentDeletedEvent#

Represents a 'comment_deleted' event on a given issue or pull request.

Implements

Fields

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!

Commit#

Represents a Git commit.

Implements

Fields

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

NameDescription
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
PullRequestOrder

Ordering options for pull requests.

author
GitActor

Authorship details of the commit.

authoredByCommitter
Boolean!

Check if the committer and the author match.

authoredDate
DateTime!

The datetime when this commit was authored.

authors
GitActorConnection!

The list of authors for this commit based on the git author and the Co-authored-by message trailer. The git author will always be first.

Arguments

NameDescription
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.

blame
Blame!

Fetches git blame information.

Arguments

NameDescription
path
String!

The file whose Git blame information you want.

changedFiles
Int!

The number of changed files in this commit.

checkSuites
CheckSuiteConnection

The check suites associated with a commit.

Arguments

NameDescription
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.

filterBy
CheckSuiteFilter

Filters the check suites by this type.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

comments
CommitCommentConnection!

Comments made on the commit.

Arguments

NameDescription
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.

commitResourcePath
URI!

The HTTP path for this Git object

commitUrl
URI!

The HTTP URL for this Git object

committedDate
DateTime!

The datetime when this commit was committed.

committedViaWeb
Boolean!

Check if committed via GitHub web UI.

committer
GitActor

Committer details of the commit.

deletions
Int!

The number of deletions in this commit.

deployments
DeploymentConnection

The deployments associated with a commit.

Arguments

NameDescription
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.

environments
[String!]

Environments to list deployments for

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
DeploymentOrder

Ordering options for deployments returned from the connection.

file
TreeEntry

The tree entry representing the file located at the given path.

Arguments

NameDescription
path
String!

The path for the file

history
CommitHistoryConnection!

The linear commit history starting from (and including) this commit, in the same order as git log.

Arguments

NameDescription
after
String

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

author
CommitAuthor

If non-null, filters history to only show commits with matching authorship.

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.

path
String

If non-null, filters history to only show commits touching files under this path.

since
GitTimestamp

Allows specifying a beginning time or date for fetching commits.

until
GitTimestamp

Allows specifying an ending time or date for fetching commits.

id
ID!
message
String!

The Git commit message

messageBody
String!

The Git commit message body

messageBodyHTML
HTML!

The commit message body rendered to HTML.

messageHeadline
String!

The Git commit message headline

messageHeadlineHTML
HTML!

The commit message headline rendered to HTML.

oid
GitObjectID!

The Git object ID

onBehalfOf
Organization

The organization this commit was made on behalf of.

parents
CommitConnection!

The parents of a commit.

Arguments

NameDescription
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.

pushedDate
DateTime

The datetime when this commit was pushed.

repository
Repository!

The Repository this commit belongs to

resourcePath
URI!

The HTTP path for this commit

signature
GitSignature

Commit signing information, if present.

status
Status

Status information for this commit

statusCheckRollup
StatusCheckRollup

Check and Status rollup information for this commit.

submodules
SubmoduleConnection!

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

Arguments

NameDescription
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.

tarballUrl
URI!

Returns a URL to download a tarball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes.

tree
Tree!

Commit's root Tree

treeResourcePath
URI!

The HTTP path for the tree of this commit

treeUrl
URI!

The HTTP URL for the tree of this commit

url
URI!

The HTTP URL for this commit

viewerCanSubscribe
Boolean!

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

viewerSubscription
SubscriptionState

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

zipballUrl
URI!

Returns a URL to download a zipball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes.

CommitComment#

Represents a comment on a given Commit.

Implements

Fields

NameDescription
author
Actor

The actor who authored the comment.

authorAssociation
CommentAuthorAssociation!

Author's association with the subject of the comment.

body
String!

Identifies the comment body.

bodyHTML
HTML!

The body rendered to HTML.

bodyText
String!

The body rendered to text.

commit
Commit

Identifies the commit associated with the comment, if the commit exists.

createdAt
DateTime!

Identifies the date and time when the object was created.

createdViaEmail
Boolean!

Check if this comment was created via an email reply.

databaseId
Int

Identifies the primary key from the database.

editor
Actor

The actor who edited the comment.

id
ID!
includesCreatedEdit
Boolean!

Check if this comment was edited and includes an edit with the creation data

isMinimized
Boolean!

Returns whether or not a comment has been minimized.

lastEditedAt
DateTime

The moment the editor made the last edit

minimizedReason
String

Returns why the comment was minimized.

path
String

Identifies the file path associated with the comment.

position
Int

Identifies the line position associated with the comment.

publishedAt
DateTime

Identifies when the comment was published at.

reactionGroups
[ReactionGroup!]

A list of reactions grouped by content left on the subject.

reactions
ReactionConnection!

A list of Reactions left on the Issue.

Arguments

NameDescription
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.

content
ReactionContent

Allows filtering Reactions by emoji.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ReactionOrder

Allows specifying the order in which reactions are returned.

repository
Repository!

The repository associated with this node.

resourcePath
URI!

The HTTP path permalink for this commit comment.

updatedAt
DateTime!

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

url
URI!

The HTTP URL permalink for this commit comment.

userContentEdits
UserContentEditConnection

A list of edits to this content.

Arguments

NameDescription
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.

viewerCanDelete
Boolean!

Check if the current viewer can delete this object.

viewerCanMinimize
Boolean!

Check if the current viewer can minimize this object.

viewerCanReact
Boolean!

Can user react to this subject

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

viewerCannotUpdateReasons
[CommentCannotUpdateReason!]!

Reasons why the current viewer can not update this comment.

viewerDidAuthor
Boolean!

Did the viewer author this comment.

CommitCommentConnection#

The connection type for CommitComment.

Fields

NameDescription
edges
[CommitCommentEdge]

A list of edges.

nodes
[CommitComment]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

CommitCommentEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
CommitComment

The item at the end of the edge.

CommitCommentThread#

A thread of comments on a commit.

Implements

Fields

NameDescription
comments
CommitCommentConnection!

The comments that exist in this thread.

Arguments

NameDescription
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 the comments were made on.

id
ID!
path
String

The file the comments were made on.

position
Int

The position in the diff for the commit that the comment was made on.

repository
Repository!

The repository associated with this node.

CommitConnection#

The connection type for Commit.

Fields

NameDescription
edges
[CommitEdge]

A list of edges.

nodes
[Commit]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

CommitContributionsByRepository#

This aggregates commits made by a user within one repository.

Fields

NameDescription
contributions
CreatedCommitContributionConnection!

The commit contributions, each representing a day.

Arguments

NameDescription
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
CommitContributionOrder

Ordering options for commit contributions returned from the connection.

repository
Repository!

The repository in which the commits were made.

resourcePath
URI!

The HTTP path for the user's commits to the repository in this time range.

url
URI!

The HTTP URL for the user's commits to the repository in this time range.

CommitEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Commit

The item at the end of the edge.

CommitHistoryConnection#

The connection type for Commit.

Fields

NameDescription
edges
[CommitEdge]

A list of edges.

nodes
[Commit]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ConnectedEvent#

Represents a 'connected' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
isCrossRepository
Boolean!

Reference originated in a different repository.

source
ReferencedSubject!

Issue or pull request that made the reference.

subject
ReferencedSubject!

Issue or pull request which was connected.

ContentAttachment#

A content attachment

Fields

NameDescription
body
String!

The body text of the content attachment. This parameter supports markdown.

contentReference
ContentReference!

The content reference that the content attachment is attached to.

databaseId
Int!

Identifies the primary key from the database.

id
ID!
title
String!

The title of the content attachment.

ContentReference#

A content reference

Fields

NameDescription
databaseId
Int!

Identifies the primary key from the database.

id
ID!
reference
String!

The reference of the content reference.

ContributionCalendar#

A calendar of contributions made on GitHub by a user.

Fields

NameDescription
colors
[String!]!

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

isHalloween
Boolean!

Determine if the color set was chosen because it's currently Halloween.

months
[ContributionCalendarMonth!]!

A list of the months of contributions in this calendar.

totalContributions
Int!

The count of total contributions in the calendar.

weeks
[ContributionCalendarWeek!]!

A list of the weeks of contributions in this calendar.

ContributionCalendarDay#

Represents a single day of contributions on GitHub by a user.

Fields

NameDescription
color
String!

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

contributionCount
Int!

How many contributions were made by the user on this day.

contributionLevel
ContributionLevel!

Indication of contributions, relative to other days. Can be used to indicate which color to represent this day on a calendar.

date
Date!

The day this square represents.

weekday
Int!

A number representing which day of the week this square represents, e.g., 1 is Monday.

ContributionCalendarMonth#

A month of contributions in a user's contribution graph.

Fields

NameDescription
firstDay
Date!

The date of the first day of this month.

name
String!

The name of the month.

totalWeeks
Int!

How many weeks started in this month.

year
Int!

The year the month occurred in.

ContributionCalendarWeek#

A week of contributions in a user's contribution graph.

Fields

NameDescription
contributionDays
[ContributionCalendarDay!]!

The days of contributions in this week.

firstDay
Date!

The date of the earliest square in this week.

ContributionsCollection#

A contributions collection aggregates contributions such as opened issues and commits created by a user.

Fields

NameDescription
commitContributionsByRepository
[CommitContributionsByRepository!]!

Commit contributions made by the user, grouped by repository.

Arguments

NameDescription
maxRepositories
Int

How many repositories should be included.

contributionCalendar
ContributionCalendar!

A calendar of this user's contributions on GitHub.

contributionYears
[Int!]!

The years the user has been making contributions with the most recent year first.

doesEndInCurrentMonth
Boolean!

Determine if this collection's time span ends in the current month.

earliestRestrictedContributionDate
Date

The date of the first restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts.

endedAt
DateTime!

The ending date and time of this collection.

firstIssueContribution
CreatedIssueOrRestrictedContribution

The first issue the user opened on GitHub. This will be null if that issue was opened outside the collection's time range and ignoreTimeRange is false. If the issue is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned.

firstPullRequestContribution
CreatedPullRequestOrRestrictedContribution

The first pull request the user opened on GitHub. This will be null if that pull request was opened outside the collection's time range and ignoreTimeRange is not true. If the pull request is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned.

firstRepositoryContribution
CreatedRepositoryOrRestrictedContribution

The first repository the user created on GitHub. This will be null if that first repository was created outside the collection's time range and ignoreTimeRange is false. If the repository is not visible, then a RestrictedContribution is returned.

hasActivityInThePast
Boolean!

Does the user have any more activity in the timeline that occurred prior to the collection's time range?

hasAnyContributions
Boolean!

Determine if there are any contributions in this collection.

hasAnyRestrictedContributions
Boolean!

Determine if the user made any contributions in this time frame whose details are not visible because they were made in a private repository. Can only be true if the user enabled private contribution counts.

isSingleDay
Boolean!

Whether or not the collector's time span is all within the same day.

issueContributions
CreatedIssueContributionConnection!

A list of issues the user opened.

Arguments

NameDescription
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.

excludeFirst
Boolean

Should the user's first issue ever be excluded from the result.

excludePopular
Boolean

Should the user's most commented issue be excluded from the result.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ContributionOrder

Ordering options for contributions returned from the connection.

issueContributionsByRepository
[IssueContributionsByRepository!]!

Issue contributions made by the user, grouped by repository.

Arguments

NameDescription
excludeFirst
Boolean

Should the user's first issue ever be excluded from the result.

excludePopular
Boolean

Should the user's most commented issue be excluded from the result.

maxRepositories
Int

How many repositories should be included.

joinedGitHubContribution
JoinedGitHubContribution

When the user signed up for GitHub. This will be null if that sign up date falls outside the collection's time range and ignoreTimeRange is false.

latestRestrictedContributionDate
Date

The date of the most recent restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts.

mostRecentCollectionWithActivity
ContributionsCollection

When this collection's time range does not include any activity from the user, use this to get a different collection from an earlier time range that does have activity.

mostRecentCollectionWithoutActivity
ContributionsCollection

Returns a different contributions collection from an earlier time range than this one that does not have any contributions.

popularIssueContribution
CreatedIssueContribution

The issue the user opened on GitHub that received the most comments in the specified time frame.

popularPullRequestContribution
CreatedPullRequestContribution

The pull request the user opened on GitHub that received the most comments in the specified time frame.

pullRequestContributions
CreatedPullRequestContributionConnection!

Pull request contributions made by the user.

Arguments

NameDescription
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.

excludeFirst
Boolean

Should the user's first pull request ever be excluded from the result.

excludePopular
Boolean

Should the user's most commented pull request be excluded from the result.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ContributionOrder

Ordering options for contributions returned from the connection.

pullRequestContributionsByRepository
[PullRequestContributionsByRepository!]!

Pull request contributions made by the user, grouped by repository.

Arguments

NameDescription
excludeFirst
Boolean

Should the user's first pull request ever be excluded from the result.

excludePopular
Boolean

Should the user's most commented pull request be excluded from the result.

maxRepositories
Int

How many repositories should be included.

pullRequestReviewContributions
CreatedPullRequestReviewContributionConnection!

Pull request review contributions made by the user.

Arguments

NameDescription
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
ContributionOrder

Ordering options for contributions returned from the connection.

pullRequestReviewContributionsByRepository
[PullRequestReviewContributionsByRepository!]!

Pull request review contributions made by the user, grouped by repository.

Arguments

NameDescription
maxRepositories
Int

How many repositories should be included.

repositoryContributions
CreatedRepositoryContributionConnection!

A list of repositories owned by the user that the user created in this time range.

Arguments

NameDescription
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.

excludeFirst
Boolean

Should the user's first repository ever be excluded from the result.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ContributionOrder

Ordering options for contributions returned from the connection.

restrictedContributionsCount
Int!

A count of contributions made by the user that the viewer cannot access. Only non-zero when the user has chosen to share their private contribution counts.

startedAt
DateTime!

The beginning date and time of this collection.

totalCommitContributions
Int!

How many commits were made by the user in this time span.

totalIssueContributions
Int!

How many issues the user opened.

Arguments

NameDescription
excludeFirst
Boolean

Should the user's first issue ever be excluded from this count.

excludePopular
Boolean

Should the user's most commented issue be excluded from this count.

totalPullRequestContributions
Int!

How many pull requests the user opened.

Arguments

NameDescription
excludeFirst
Boolean

Should the user's first pull request ever be excluded from this count.

excludePopular
Boolean

Should the user's most commented pull request be excluded from this count.

totalPullRequestReviewContributions
Int!

How many pull request reviews the user left.

totalRepositoriesWithContributedCommits
Int!

How many different repositories the user committed to.

totalRepositoriesWithContributedIssues
Int!

How many different repositories the user opened issues in.

Arguments

NameDescription
excludeFirst
Boolean

Should the user's first issue ever be excluded from this count.

excludePopular
Boolean

Should the user's most commented issue be excluded from this count.

totalRepositoriesWithContributedPullRequestReviews
Int!

How many different repositories the user left pull request reviews in.

totalRepositoriesWithContributedPullRequests
Int!

How many different repositories the user opened pull requests in.

Arguments

NameDescription
excludeFirst
Boolean

Should the user's first pull request ever be excluded from this count.

excludePopular
Boolean

Should the user's most commented pull request be excluded from this count.

totalRepositoryContributions
Int!

How many repositories the user created.

Arguments

NameDescription
excludeFirst
Boolean

Should the user's first repository ever be excluded from this count.

user
User!

The user who made the contributions in this collection.

ConvertedNoteToIssueEvent#

Represents a 'converted_note_to_issue' event on a given issue or pull request.

Implements

Fields

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.

id
ID!
project
Project

Project referenced by event.

projectCard
ProjectCard

Project card referenced by this project event.

projectColumnName
String!

Column name referenced by this project event.

ConvertProjectCardNoteToIssuePayload#

Autogenerated return type of ConvertProjectCardNoteToIssue

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

projectCard
ProjectCard

The updated ProjectCard.

ConvertToDraftEvent#

Represents a 'convert_to_draft' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

resourcePath
URI!

The HTTP path for this convert to draft event.

url
URI!

The HTTP URL for this convert to draft event.

CreateBranchProtectionRulePayload#

Autogenerated return type of CreateBranchProtectionRule

Fields

NameDescription
branchProtectionRule
BranchProtectionRule

The newly created BranchProtectionRule.

clientMutationId
String

A unique identifier for the client performing the mutation.

CreateCheckRunPayload#

Autogenerated return type of CreateCheckRun

Fields

NameDescription
checkRun
CheckRun

The newly created check run.

clientMutationId
String

A unique identifier for the client performing the mutation.

CreateCheckSuitePayload#

Autogenerated return type of CreateCheckSuite

Fields

NameDescription
checkSuite
CheckSuite

The newly created check suite.

clientMutationId
String

A unique identifier for the client performing the mutation.

CreateContentAttachmentPayload#

Autogenerated return type of CreateContentAttachment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

contentAttachment
ContentAttachment

The newly created content attachment.

CreatedCommitContribution#

Represents the contribution a user made by committing to a repository.

Implements

Fields

NameDescription
commitCount
Int!

How many commits were made on this day to this repository by the user.

isRestricted
Boolean!

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt
DateTime!

When this contribution was made.

repository
Repository!

The repository the user made a commit in.

resourcePath
URI!

The HTTP path for this contribution.

url
URI!

The HTTP URL for this contribution.

user
User!

The user who made this contribution.

CreatedCommitContributionConnection#

The connection type for CreatedCommitContribution.

Fields

NameDescription
edges
[CreatedCommitContributionEdge]

A list of edges.

nodes
[CreatedCommitContribution]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of commits across days and repositories in the connection.

CreatedCommitContributionEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
CreatedCommitContribution

The item at the end of the edge.

CreateDeploymentPayload#

Autogenerated return type of CreateDeployment

Fields

NameDescription
autoMerged
Boolean

True if the default branch has been auto-merged into the deployment ref.

clientMutationId
String

A unique identifier for the client performing the mutation.

deployment
Deployment

The new deployment.

CreateDeploymentStatusPayload#

Autogenerated return type of CreateDeploymentStatus

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

deploymentStatus
DeploymentStatus

The new deployment status.

CreatedIssueContribution#

Represents the contribution a user made on GitHub by opening an issue.

Implements

Fields

NameDescription
isRestricted
Boolean!

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

issue
Issue!

The issue that was opened.

occurredAt
DateTime!

When this contribution was made.

resourcePath
URI!

The HTTP path for this contribution.

url
URI!

The HTTP URL for this contribution.

user
User!

The user who made this contribution.

CreatedIssueContributionConnection#

The connection type for CreatedIssueContribution.

Fields

NameDescription
edges
[CreatedIssueContributionEdge]

A list of edges.

nodes
[CreatedIssueContribution]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

CreatedIssueContributionEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
CreatedIssueContribution

The item at the end of the edge.

CreatedPullRequestContribution#

Represents the contribution a user made on GitHub by opening a pull request.

Implements

Fields

NameDescription
isRestricted
Boolean!

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt
DateTime!

When this contribution was made.

pullRequest
PullRequest!

The pull request that was opened.

resourcePath
URI!

The HTTP path for this contribution.

url
URI!

The HTTP URL for this contribution.

user
User!

The user who made this contribution.

CreatedPullRequestContributionConnection#

The connection type for CreatedPullRequestContribution.

Fields

NameDescription
edges
[CreatedPullRequestContributionEdge]

A list of edges.

nodes
[CreatedPullRequestContribution]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

CreatedPullRequestContributionEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
CreatedPullRequestContribution

The item at the end of the edge.

CreatedPullRequestReviewContribution#

Represents the contribution a user made by leaving a review on a pull request.

Implements

Fields

NameDescription
isRestricted
Boolean!

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt
DateTime!

When this contribution was made.

pullRequest
PullRequest!

The pull request the user reviewed.

pullRequestReview
PullRequestReview!

The review the user left on the pull request.

repository
Repository!

The repository containing the pull request that the user reviewed.

resourcePath
URI!

The HTTP path for this contribution.

url
URI!

The HTTP URL for this contribution.

user
User!

The user who made this contribution.

CreatedPullRequestReviewContributionConnection#

The connection type for CreatedPullRequestReviewContribution.

Fields

NameDescription
edges
[CreatedPullRequestReviewContributionEdge]

A list of edges.

nodes
[CreatedPullRequestReviewContribution]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

CreatedPullRequestReviewContributionEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
CreatedPullRequestReviewContribution

The item at the end of the edge.

CreatedRepositoryContribution#

Represents the contribution a user made on GitHub by creating a repository.

Implements

Fields

NameDescription
isRestricted
Boolean!

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt
DateTime!

When this contribution was made.

repository
Repository!

The repository that was created.

resourcePath
URI!

The HTTP path for this contribution.

url
URI!

The HTTP URL for this contribution.

user
User!

The user who made this contribution.

CreatedRepositoryContributionConnection#

The connection type for CreatedRepositoryContribution.

Fields

NameDescription
edges
[CreatedRepositoryContributionEdge]

A list of edges.

nodes
[CreatedRepositoryContribution]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

CreatedRepositoryContributionEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
CreatedRepositoryContribution

The item at the end of the edge.

CreateEnterpriseOrganizationPayload#

Autogenerated return type of CreateEnterpriseOrganization

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise that owns the created organization.

organization
Organization

The organization that was created.

CreateIpAllowListEntryPayload#

Autogenerated return type of CreateIpAllowListEntry

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

ipAllowListEntry
IpAllowListEntry

The IP allow list entry that was created.

CreateIssuePayload#

Autogenerated return type of CreateIssue

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issue
Issue

The new issue.

CreateLabelPayload#

Autogenerated return type of CreateLabel

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

label
Label

The new label.

CreateProjectPayload#

Autogenerated return type of CreateProject

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

project
Project

The new project.

CreatePullRequestPayload#

Autogenerated return type of CreatePullRequest

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The new pull request.

CreateRefPayload#

Autogenerated return type of CreateRef

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

ref
Ref

The newly created ref.

CreateRepositoryPayload#

Autogenerated return type of CreateRepository

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repository
Repository

The new repository.

CreateTeamDiscussionCommentPayload#

Autogenerated return type of CreateTeamDiscussionComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

teamDiscussionComment
TeamDiscussionComment

The new comment.

CreateTeamDiscussionPayload#

Autogenerated return type of CreateTeamDiscussion

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

teamDiscussion
TeamDiscussion

The new discussion.

CrossReferencedEvent#

Represents a mention made by one issue or pull request to another.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
isCrossRepository
Boolean!

Reference originated in a different repository.

referencedAt
DateTime!

Identifies when the reference was made.

resourcePath
URI!

The HTTP path for this pull request.

source
ReferencedSubject!

Issue or pull request that made the reference.

target
ReferencedSubject!

Issue or pull request to which the reference was made.

url
URI!

The HTTP URL for this pull request.

willCloseTarget
Boolean!

Checks if the target will be closed when the source is merged.

CVSS#

The Common Vulnerability Scoring System

Fields

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

Implements

Fields

NameDescription
cweId
String!

The id of the CWE

description
String!

A detailed description of this CWE

id
ID!

ID of the object.

name
String!

The name of this CWE

CWEConnection#

The connection type for CWE.

Fields

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

NameDescription
cursor
String!

A cursor for use in pagination.

node
CWE

The item at the end of the edge.

DeclineTopicSuggestionPayload#

Autogenerated return type of DeclineTopicSuggestion

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

topic
Topic

The declined topic.

DeleteBranchProtectionRulePayload#

Autogenerated return type of DeleteBranchProtectionRule

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

DeleteDeploymentPayload#

Autogenerated return type of DeleteDeployment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

DeleteIpAllowListEntryPayload#

Autogenerated return type of DeleteIpAllowListEntry

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

ipAllowListEntry
IpAllowListEntry

The IP allow list entry that was deleted.

DeleteIssueCommentPayload#

Autogenerated return type of DeleteIssueComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

DeleteIssuePayload#

Autogenerated return type of DeleteIssue

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repository
Repository

The repository the issue belonged to

DeleteLabelPayload#

Autogenerated return type of DeleteLabel

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

DeletePackageVersionPayload#

Autogenerated return type of DeletePackageVersion

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

success
Boolean

Whether or not the operation succeeded.

DeleteProjectCardPayload#

Autogenerated return type of DeleteProjectCard

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

column
ProjectColumn

The column the deleted card was in.

deletedCardId
ID

The deleted card ID.

DeleteProjectColumnPayload#

Autogenerated return type of DeleteProjectColumn

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

deletedColumnId
ID

The deleted column ID.

project
Project

The project the deleted column was in.

DeleteProjectPayload#

Autogenerated return type of DeleteProject

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

owner
ProjectOwner

The repository or organization the project was removed from.

DeletePullRequestReviewCommentPayload#

Autogenerated return type of DeletePullRequestReviewComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestReview
PullRequestReview

The pull request review the deleted comment belonged to.

DeletePullRequestReviewPayload#

Autogenerated return type of DeletePullRequestReview

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestReview
PullRequestReview

The deleted pull request review.

DeleteRefPayload#

Autogenerated return type of DeleteRef

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

DeleteTeamDiscussionCommentPayload#

Autogenerated return type of DeleteTeamDiscussionComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

DeleteTeamDiscussionPayload#

Autogenerated return type of DeleteTeamDiscussion

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

DeleteVerifiableDomainPayload#

Autogenerated return type of DeleteVerifiableDomain

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

owner
VerifiableDomainOwner

The owning account from which the domain was deleted.

DemilestonedEvent#

Represents a 'demilestoned' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
milestoneTitle
String!

Identifies the milestone title associated with the 'demilestoned' event.

subject
MilestoneItem!

Object referenced by event.

DependencyGraphDependency#

A dependency manifest entry

Fields

NameDescription
hasDependencies
Boolean!

Does the dependency itself have dependencies?

packageManager
String

The dependency package manager

packageName
String!

The required package name

repository
Repository

The repository containing the package

requirements
String!

The dependency version requirements

DependencyGraphDependencyConnection#

The connection type for DependencyGraphDependency.

Fields

NameDescription
edges
[DependencyGraphDependencyEdge]

A list of edges.

nodes
[DependencyGraphDependency]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

DependencyGraphDependencyEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
DependencyGraphDependency

The item at the end of the edge.

DependencyGraphManifest#

Dependency manifest for a repository

Implements

Fields

NameDescription
blobPath
String!

Path to view the manifest file blob

dependencies
DependencyGraphDependencyConnection

A list of manifest dependencies

Arguments

NameDescription
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.

dependenciesCount
Int

The number of dependencies listed in the manifest

exceedsMaxSize
Boolean!

Is the manifest too big to parse?

filename
String!

Fully qualified manifest filename

id
ID!
parseable
Boolean!

Were we able to parse the manifest?

repository
Repository!

The repository containing the manifest

DependencyGraphManifestConnection#

The connection type for DependencyGraphManifest.

Fields

NameDescription
edges
[DependencyGraphManifestEdge]

A list of edges.

nodes
[DependencyGraphManifest]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

DependencyGraphManifestEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
DependencyGraphManifest

The item at the end of the edge.

DeployedEvent#

Represents a 'deployed' event on a given pull request.

Implements

Fields

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.

deployment
Deployment!

The deployment associated with the 'deployed' event.

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

ref
Ref

The ref associated with the 'deployed' event.

DeployKey#

A repository deploy key.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
key
String!

The deploy key.

readOnly
Boolean!

Whether or not the deploy key is read only.

title
String!

The deploy key title.

verified
Boolean!

Whether or not the deploy key has been verified.

DeployKeyConnection#

The connection type for DeployKey.

Fields

NameDescription
edges
[DeployKeyEdge]

A list of edges.

nodes
[DeployKey]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

DeployKeyEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
DeployKey

The item at the end of the edge.

Deployment#

Represents triggered deployment instance.

Implements

Fields

NameDescription
commit
Commit

Identifies the commit sha of the deployment.

commitOid
String!

Identifies the oid of the deployment commit, even if the commit has been deleted.

createdAt
DateTime!

Identifies the date and time when the object was created.

creator
Actor!

Identifies the actor who triggered the deployment.

databaseId
Int

Identifies the primary key from the database.

description
String

The deployment description.

environment
String

The latest environment to which this deployment was made.

id
ID!
latestEnvironment
String

The latest environment to which this deployment was made.

latestStatus
DeploymentStatus

The latest status of this deployment.

originalEnvironment
String

The original environment to which this deployment was made.

payload
String

Extra information that a deployment system might need.

ref
Ref

Identifies the Ref of the deployment, if the deployment was created by ref.

repository
Repository!

Identifies the repository associated with the deployment.

state
DeploymentState

The current state of the deployment.

statuses
DeploymentStatusConnection

A list of statuses associated with the deployment.

Arguments

NameDescription
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.

task
String

The deployment task.

updatedAt
DateTime!

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

DeploymentConnection#

The connection type for Deployment.

Fields

NameDescription
edges
[DeploymentEdge]

A list of edges.

nodes
[Deployment]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

DeploymentEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Deployment

The item at the end of the edge.

DeploymentEnvironmentChangedEvent#

Represents a 'deployment_environment_changed' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

deploymentStatus
DeploymentStatus!

The deployment status that updated the deployment environment.

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

DeploymentStatus#

Describes the status of a given deployment attempt.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

creator
Actor!

Identifies the actor who triggered the deployment.

deployment
Deployment!

Identifies the deployment associated with status.

description
String

Identifies the description of the deployment.

environment
String

Identifies the environment of the deployment at the time of this deployment status

environmentUrl
URI

Identifies the environment URL of the deployment.

id
ID!
logUrl
URI

Identifies the log URL of the deployment.

state
DeploymentStatusState!

Identifies the current state of the deployment.

updatedAt
DateTime!

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

DeploymentStatusConnection#

The connection type for DeploymentStatus.

Fields

NameDescription
edges
[DeploymentStatusEdge]

A list of edges.

nodes
[DeploymentStatus]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

DeploymentStatusEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
DeploymentStatus

The item at the end of the edge.

DisablePullRequestAutoMergePayload#

Autogenerated return type of DisablePullRequestAutoMerge

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The pull request auto merge was disabled on.

DisconnectedEvent#

Represents a 'disconnected' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
isCrossRepository
Boolean!

Reference originated in a different repository.

source
ReferencedSubject!

Issue or pull request from which the issue was disconnected.

subject
ReferencedSubject!

Issue or pull request which was disconnected.

DismissPullRequestReviewPayload#

Autogenerated return type of DismissPullRequestReview

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestReview
PullRequestReview

The dismissed pull request review.

EnablePullRequestAutoMergePayload#

Autogenerated return type of EnablePullRequestAutoMerge

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The pull request auto-merge was enabled on.

Enterprise#

An account to manage multiple organizations with consolidated policy and billing.

Implements

Fields

NameDescription
avatarUrl
URI!

A URL pointing to the enterprise's public avatar.

Arguments

NameDescription
size
Int

The size of the resulting square image.

billingInfo
EnterpriseBillingInfo

Enterprise billing informationย visible to enterprise billing managers.

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 enterprise.

descriptionHTML
HTML!

The description of the enterprise as HTML.

id
ID!
location
String

The location of the enterprise.

members
EnterpriseMemberConnection!

A list of users who are members of this enterprise.

Arguments

NameDescription
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.

deployment
EnterpriseUserDeployment

Only return members within the selected GitHub Enterprise deployment

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
EnterpriseMemberOrder

Ordering options for members returned from the connection.

organizationLogins
[String!]

Only return members within the organizations with these logins

query
String

The search string to look for.

role
EnterpriseUserAccountMembershipRole

The role of the user in the enterprise organization or server.

name
String!

The name of the enterprise.

organizations
OrganizationConnection!

A list of organizations that belong to this enterprise.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations returned from the connection.

query
String

The search string to look for.

ownerInfo
EnterpriseOwnerInfo

Enterprise information only visible to enterprise owners.

resourcePath
URI!

The HTTP path for this enterprise.

slug
String!

The URL-friendly identifier for the enterprise.

url
URI!

The HTTP URL for this enterprise.

userAccounts
EnterpriseUserAccountConnection!

A list of user accounts on this enterprise.

Arguments

NameDescription
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.

viewerIsAdmin
Boolean!

Is the current viewer an admin of this enterprise?

websiteUrl
URI

The URL of the enterprise website.

EnterpriseAdministratorConnection#

The connection type for User.

Fields

NameDescription
edges
[EnterpriseAdministratorEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseAdministratorEdge#

A User who is an administrator of an enterprise.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
User

The item at the end of the edge.

role
EnterpriseAdministratorRole!

The role of the administrator.

EnterpriseAdministratorInvitation#

An invitation for a user to become an owner or billing manager of an enterprise.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

email
String

The email of the person who was invited to the enterprise.

enterprise
Enterprise!

The enterprise the invitation is for.

id
ID!
invitee
User

The user who was invited to the enterprise.

inviter
User

The user who created the invitation.

role
EnterpriseAdministratorRole!

The invitee's pending role in the enterprise (owner or billing_manager).

EnterpriseAdministratorInvitationConnection#

The connection type for EnterpriseAdministratorInvitation.

Fields

NameDescription
edges
[EnterpriseAdministratorInvitationEdge]

A list of edges.

nodes
[EnterpriseAdministratorInvitation]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseAdministratorInvitationEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
EnterpriseAdministratorInvitation

The item at the end of the edge.

EnterpriseBillingInfo#

Enterprise billing information visible to enterprise billing managers and owners.

Fields

NameDescription
allLicensableUsersCount
Int!

The number of licenseable users/emails across the enterprise.

assetPacks
Int!

The number of data packs used by all organizations owned by the enterprise.

availableSeats
Int!
Deprecated: `availableSeats` will be replaced with `totalAvailableLicenses` to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

The number of available seats across all owned organizations based on the unique number of billable users.

bandwidthQuota
Float!

The bandwidth quota in GB for all organizations owned by the enterprise.

bandwidthUsage
Float!

The bandwidth usage in GB for all organizations owned by the enterprise.

bandwidthUsagePercentage
Int!

The bandwidth usage as a percentage of the bandwidth quota.

seats
Int!
Deprecated: `seats` will be replaced with `totalLicenses` to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

The total seats across all organizations owned by the enterprise.

storageQuota
Float!

The storage quota in GB for all organizations owned by the enterprise.

storageUsage
Float!

The storage usage in GB for all organizations owned by the enterprise.

storageUsagePercentage
Int!

The storage usage as a percentage of the storage quota.

totalAvailableLicenses
Int!

The number of available licenses across all owned organizations based on the unique number of billable users.

totalLicenses
Int!

The total number of licenses allocated.

EnterpriseIdentityProvider#

An identity provider configured to provision identities for an enterprise.

Implements

Fields

NameDescription
digestMethod
SamlDigestAlgorithm

The digest algorithm used to sign SAML requests for the identity provider.

enterprise
Enterprise

The enterprise this identity provider belongs to.

externalIdentities
ExternalIdentityConnection!

ExternalIdentities provisioned by this identity provider.

Arguments

NameDescription
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.

id
ID!
idpCertificate
X509Certificate

The x509 certificate used by the identity provider to sign assertions and responses.

issuer
String

The Issuer Entity ID for the SAML identity provider.

recoveryCodes
[String!]

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

signatureMethod
SamlSignatureAlgorithm

The signature algorithm used to sign SAML requests for the identity provider.

ssoUrl
URI

The URL endpoint for the identity provider's SAML SSO.

EnterpriseMemberConnection#

The connection type for EnterpriseMember.

Fields

NameDescription
edges
[EnterpriseMemberEdge]

A list of edges.

nodes
[EnterpriseMember]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseMemberEdge#

A User who is a member of an enterprise through one or more organizations.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

isUnlicensed
Boolean!
Deprecated: All members consume a license Removal on 2021-01-01 UTC.

Whether the user does not have a license for the enterprise.

node
EnterpriseMember

The item at the end of the edge.

EnterpriseOrganizationMembershipConnection#

The connection type for Organization.

Fields

NameDescription
edges
[EnterpriseOrganizationMembershipEdge]

A list of edges.

nodes
[Organization]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseOrganizationMembershipEdge#

An enterprise organization that a user is a member of.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Organization

The item at the end of the edge.

role
EnterpriseUserAccountMembershipRole!

The role of the user in the enterprise membership.

EnterpriseOutsideCollaboratorConnection#

The connection type for User.

Fields

NameDescription
edges
[EnterpriseOutsideCollaboratorEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseOutsideCollaboratorEdge#

A User who is an outside collaborator of an enterprise through one or more organizations.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

isUnlicensed
Boolean!
Deprecated: All outside collaborators consume a license Removal on 2021-01-01 UTC.

Whether the outside collaborator does not have a license for the enterprise.

node
User

The item at the end of the edge.

repositories
EnterpriseRepositoryInfoConnection!

The enterprise organization repositories this user is a member of.

Arguments

NameDescription
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
RepositoryOrder

Ordering options for repositories.

EnterpriseOwnerInfo#

Enterprise information only visible to enterprise owners.

Fields

NameDescription
admins
EnterpriseAdministratorConnection!

A list of all of the administrators for this enterprise.

Arguments

NameDescription
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
EnterpriseMemberOrder

Ordering options for administrators returned from the connection.

query
String

The search string to look for.

role
EnterpriseAdministratorRole

The role to filter by.

affiliatedUsersWithTwoFactorDisabled
UserConnection!

A list of users in the enterprise who currently have two-factor authentication disabled.

Arguments

NameDescription
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.

affiliatedUsersWithTwoFactorDisabledExist
Boolean!

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

allowPrivateRepositoryForkingSetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

allowPrivateRepositoryForkingSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided private repository forking setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

defaultRepositoryPermissionSetting
EnterpriseDefaultRepositoryPermissionSettingValue!

The setting value for base repository permissions for organizations in this enterprise.

defaultRepositoryPermissionSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided default repository permission.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
DefaultRepositoryPermissionField!

The permission to find organizations for.

domains
VerifiableDomainConnection!

A list of domains owned by the enterprise.

Arguments

NameDescription
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.

isVerified
Boolean

Filter whether or not the domain is verified.

last
Int

Returns the last n elements from the list.

orderBy
VerifiableDomainOrder

Ordering options for verifiable domains returned.

enterpriseServerInstallations
EnterpriseServerInstallationConnection!

Enterprise Server installations owned by the enterprise.

Arguments

NameDescription
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.

connectedOnly
Boolean

Whether or not to only return installations discovered via GitHub Connect.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
EnterpriseServerInstallationOrder

Ordering options for Enterprise Server installations returned.

ipAllowListEnabledSetting
IpAllowListEnabledSettingValue!

The setting value for whether the enterprise has an IP allow list enabled.

ipAllowListEntries
IpAllowListEntryConnection!

The IP addresses that are allowed to access resources owned by the enterprise.

Arguments

NameDescription
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
IpAllowListEntryOrder

Ordering options for IP allow list entries returned.

isUpdatingDefaultRepositoryPermission
Boolean!

Whether or not the default repository permission is currently being updated.

isUpdatingTwoFactorRequirement
Boolean!

Whether the two-factor authentication requirement is currently being enforced.

membersCanChangeRepositoryVisibilitySetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether organization members with admin permissions on a repository can change repository visibility.

membersCanChangeRepositoryVisibilitySettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided can change repository visibility setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

membersCanCreateInternalRepositoriesSetting
Boolean

The setting value for whether members of organizations in the enterprise can create internal repositories.

membersCanCreatePrivateRepositoriesSetting
Boolean

The setting value for whether members of organizations in the enterprise can create private repositories.

membersCanCreatePublicRepositoriesSetting
Boolean

The setting value for whether members of organizations in the enterprise can create public repositories.

membersCanCreateRepositoriesSetting
EnterpriseMembersCanCreateRepositoriesSettingValue

The setting value for whether members of organizations in the enterprise can create repositories.

membersCanCreateRepositoriesSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided repository creation setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
OrganizationMembersCanCreateRepositoriesSettingValue!

The setting to find organizations for.

membersCanDeleteIssuesSetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether members with admin permissions for repositories can delete issues.

membersCanDeleteIssuesSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided members can delete issues setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

membersCanDeleteRepositoriesSetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

membersCanDeleteRepositoriesSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided members can delete repositories setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

membersCanInviteCollaboratorsSetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

membersCanInviteCollaboratorsSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

membersCanMakePurchasesSetting
EnterpriseMembersCanMakePurchasesSettingValue!

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

membersCanUpdateProtectedBranchesSetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether members with admin permissions for repositories can update protected branches.

membersCanUpdateProtectedBranchesSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided members can update protected branches setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

membersCanViewDependencyInsightsSetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether members can view dependency insights.

membersCanViewDependencyInsightsSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

notificationDeliveryRestrictionEnabledSetting
NotificationRestrictionSettingValue!

Indicates if email notification delivery for this enterprise is restricted to verified domains.

organizationProjectsSetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether organization projects are enabled for organizations in this enterprise.

organizationProjectsSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided organization projects setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

outsideCollaborators
EnterpriseOutsideCollaboratorConnection!

A list of outside collaborators across the repositories in the enterprise.

Arguments

NameDescription
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.

login
String

The login of one specific outside collaborator.

orderBy
EnterpriseMemberOrder

Ordering options for outside collaborators returned from the connection.

query
String

The search string to look for.

visibility
RepositoryVisibility

Only return outside collaborators on repositories with this visibility.

pendingAdminInvitations
EnterpriseAdministratorInvitationConnection!

A list of pending administrator invitations for the enterprise.

Arguments

NameDescription
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
EnterpriseAdministratorInvitationOrder

Ordering options for pending enterprise administrator invitations returned from the connection.

query
String

The search string to look for.

role
EnterpriseAdministratorRole

The role to filter by.

pendingCollaboratorInvitations
RepositoryInvitationConnection!

A list of pending collaborator invitations across the repositories in the enterprise.

Arguments

NameDescription
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
RepositoryInvitationOrder

Ordering options for pending repository collaborator invitations returned from the connection.

query
String

The search string to look for.

pendingCollaborators
EnterprisePendingCollaboratorConnection!
Deprecated: Repository invitations can now be associated with an email, not only an invitee. Use the `pendingCollaboratorInvitations` field instead. Removal on 2020-10-01 UTC.

A list of pending collaborators across the repositories in the enterprise.

Arguments

NameDescription
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
RepositoryInvitationOrder

Ordering options for pending repository collaborator invitations returned from the connection.

query
String

The search string to look for.

pendingMemberInvitations
EnterprisePendingMemberInvitationConnection!

A list of pending member invitations for organizations in the enterprise.

Arguments

NameDescription
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

The search string to look for.

repositoryProjectsSetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether repository projects are enabled in this enterprise.

repositoryProjectsSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided repository projects setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

samlIdentityProvider
EnterpriseIdentityProvider

The SAML Identity Provider for the enterprise.

samlIdentityProviderSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the SAML single sign-on setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
IdentityProviderConfigurationState!

The setting value to find organizations for.

supportEntitlements
EnterpriseMemberConnection!

A list of members with a support entitlement.

Arguments

NameDescription
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
EnterpriseMemberOrder

Ordering options for support entitlement users returned from the connection.

teamDiscussionsSetting
EnterpriseEnabledDisabledSettingValue!

The setting value for whether team discussions are enabled for organizations in this enterprise.

teamDiscussionsSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the provided team discussions setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

twoFactorRequiredSetting
EnterpriseEnabledSettingValue!

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

twoFactorRequiredSettingOrganizations
OrganizationConnection!

A list of enterprise organizations configured with the two-factor authentication setting value.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations with this setting.

value
Boolean!

The setting value to find organizations for.

EnterprisePendingCollaboratorConnection#

The connection type for User.

Fields

NameDescription
edges
[EnterprisePendingCollaboratorEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterprisePendingCollaboratorEdge#

A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

isUnlicensed
Boolean!
Deprecated: All pending collaborators consume a license Removal on 2021-01-01 UTC.

Whether the invited collaborator does not have a license for the enterprise.

node
User

The item at the end of the edge.

repositories
EnterpriseRepositoryInfoConnection!

The enterprise organization repositories this user is a member of.

Arguments

NameDescription
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
RepositoryOrder

Ordering options for repositories.

EnterprisePendingMemberInvitationConnection#

The connection type for OrganizationInvitation.

Fields

NameDescription
edges
[EnterprisePendingMemberInvitationEdge]

A list of edges.

nodes
[OrganizationInvitation]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

totalUniqueUserCount
Int!

Identifies the total count of unique users in the connection.

EnterprisePendingMemberInvitationEdge#

An invitation to be a member in an enterprise organization.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

isUnlicensed
Boolean!
Deprecated: All pending members consume a license Removal on 2020-07-01 UTC.

Whether the invitation has a license for the enterprise.

node
OrganizationInvitation

The item at the end of the edge.

EnterpriseRepositoryInfo#

A subset of repository information queryable from an enterprise.

Implements

Fields

NameDescription
id
ID!
isPrivate
Boolean!

Identifies if the repository is private or internal.

name
String!

The repository's name.

nameWithOwner
String!

The repository's name with owner.

EnterpriseRepositoryInfoConnection#

The connection type for EnterpriseRepositoryInfo.

Fields

NameDescription
edges
[EnterpriseRepositoryInfoEdge]

A list of edges.

nodes
[EnterpriseRepositoryInfo]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseRepositoryInfoEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
EnterpriseRepositoryInfo

The item at the end of the edge.

EnterpriseServerInstallation#

An Enterprise Server installation.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

customerName
String!

The customer name to which the Enterprise Server installation belongs.

hostName
String!

The host name of the Enterprise Server installation.

id
ID!
isConnected
Boolean!

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

updatedAt
DateTime!

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

userAccounts
EnterpriseServerUserAccountConnection!

User accounts on this Enterprise Server installation.

Arguments

NameDescription
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
EnterpriseServerUserAccountOrder

Ordering options for Enterprise Server user accounts returned from the connection.

userAccountsUploads
EnterpriseServerUserAccountsUploadConnection!

User accounts uploads for the Enterprise Server installation.

Arguments

NameDescription
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
EnterpriseServerUserAccountsUploadOrder

Ordering options for Enterprise Server user accounts uploads returned from the connection.

EnterpriseServerInstallationConnection#

The connection type for EnterpriseServerInstallation.

Fields

NameDescription
edges
[EnterpriseServerInstallationEdge]

A list of edges.

nodes
[EnterpriseServerInstallation]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseServerInstallationEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
EnterpriseServerInstallation

The item at the end of the edge.

EnterpriseServerUserAccount#

A user account on an Enterprise Server installation.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

emails
EnterpriseServerUserAccountEmailConnection!

User emails belonging to this user account.

Arguments

NameDescription
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
EnterpriseServerUserAccountEmailOrder

Ordering options for Enterprise Server user account emails returned from the connection.

enterpriseServerInstallation
EnterpriseServerInstallation!

The Enterprise Server installation on which this user account exists.

id
ID!
isSiteAdmin
Boolean!

Whether the user account is a site administrator on the Enterprise Server installation.

login
String!

The login of the user account on the Enterprise Server installation.

profileName
String

The profile name of the user account on the Enterprise Server installation.

remoteCreatedAt
DateTime!

The date and time when the user account was created on the Enterprise Server installation.

remoteUserId
Int!

The ID of the user account on the Enterprise Server installation.

updatedAt
DateTime!

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

EnterpriseServerUserAccountConnection#

The connection type for EnterpriseServerUserAccount.

Fields

NameDescription
edges
[EnterpriseServerUserAccountEdge]

A list of edges.

nodes
[EnterpriseServerUserAccount]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseServerUserAccountEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
EnterpriseServerUserAccount

The item at the end of the edge.

EnterpriseServerUserAccountEmail#

An email belonging to a user account on an Enterprise Server installation.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

email
String!

The email address.

id
ID!
isPrimary
Boolean!

Indicates whether this is the primary email of the associated user account.

updatedAt
DateTime!

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

userAccount
EnterpriseServerUserAccount!

The user account to which the email belongs.

EnterpriseServerUserAccountEmailConnection#

The connection type for EnterpriseServerUserAccountEmail.

Fields

NameDescription
edges
[EnterpriseServerUserAccountEmailEdge]

A list of edges.

nodes
[EnterpriseServerUserAccountEmail]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseServerUserAccountEmailEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
EnterpriseServerUserAccountEmail

The item at the end of the edge.

EnterpriseServerUserAccountsUpload#

A user accounts upload from an Enterprise Server installation.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

enterprise
Enterprise!

The enterprise to which this upload belongs.

enterpriseServerInstallation
EnterpriseServerInstallation!

The Enterprise Server installation for which this upload was generated.

id
ID!
name
String!

The name of the file uploaded.

syncState
EnterpriseServerUserAccountsUploadSyncState!

The synchronization state of the upload

updatedAt
DateTime!

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

EnterpriseServerUserAccountsUploadConnection#

The connection type for EnterpriseServerUserAccountsUpload.

Fields

NameDescription
edges
[EnterpriseServerUserAccountsUploadEdge]

A list of edges.

nodes
[EnterpriseServerUserAccountsUpload]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseServerUserAccountsUploadEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
EnterpriseServerUserAccountsUpload

The item at the end of the edge.

EnterpriseUserAccount#

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

Implements

Fields

NameDescription
avatarUrl
URI!

A URL pointing to the enterprise user account's public avatar.

Arguments

NameDescription
size
Int

The size of the resulting square image.

createdAt
DateTime!

Identifies the date and time when the object was created.

enterprise
Enterprise!

The enterprise in which this user account exists.

id
ID!
login
String!

An identifier for the enterprise user account, a login or email address

name
String

The name of the enterprise user account

organizations
EnterpriseOrganizationMembershipConnection!

A list of enterprise organizations this user is a member of.

Arguments

NameDescription
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
OrganizationOrder

Ordering options for organizations returned from the connection.

query
String

The search string to look for.

role
EnterpriseUserAccountMembershipRole

The role of the user in the enterprise organization.

resourcePath
URI!

The HTTP path for this user.

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this user.

user
User

The user within the enterprise.

EnterpriseUserAccountConnection#

The connection type for EnterpriseUserAccount.

Fields

NameDescription
edges
[EnterpriseUserAccountEdge]

A list of edges.

nodes
[EnterpriseUserAccount]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EnterpriseUserAccountEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
EnterpriseUserAccount

The item at the end of the edge.

ExternalIdentity#

An external identity provisioned by SAML SSO or SCIM.

Implements

Fields

NameDescription
guid
String!

The GUID for this identity

id
ID!
organizationInvitation
OrganizationInvitation

Organization invitation for this SCIM-provisioned external identity

samlIdentity
ExternalIdentitySamlAttributes

SAML Identity attributes

scimIdentity
ExternalIdentityScimAttributes

SCIM Identity attributes

user
User

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

ExternalIdentityConnection#

The connection type for ExternalIdentity.

Fields

NameDescription
edges
[ExternalIdentityEdge]

A list of edges.

nodes
[ExternalIdentity]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ExternalIdentityEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
ExternalIdentity

The item at the end of the edge.

ExternalIdentitySamlAttributes#

SAML attributes for the External Identity

Fields

NameDescription
emails
[UserEmailMetadata!]

The emails associated with the SAML identity

familyName
String

Family name of the SAML identity

givenName
String

Given name of the SAML identity

groups
[String!]

The groups linked to this identity in IDP

nameId
String

The NameID of the SAML identity

username
String

The userName of the SAML identity

ExternalIdentityScimAttributes#

SCIM attributes for the External Identity

Fields

NameDescription
emails
[UserEmailMetadata!]

The emails associated with the SCIM identity

familyName
String

Family name of the SCIM identity

givenName
String

Given name of the SCIM identity

groups
[String!]

The groups linked to this identity in IDP

username
String

The userName of the SCIM identity

FollowerConnection#

The connection type for User.

Fields

NameDescription
edges
[UserEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

FollowingConnection#

The connection type for User.

Fields

NameDescription
edges
[UserEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

FollowUserPayload#

Autogenerated return type of FollowUser

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

user
User

The user that was followed.

FundingLink#

A funding platform link for a repository.

Fields

NameDescription
platform
FundingPlatform!

The funding platform this link is for.

url
URI!

The configured URL for this funding link.

GenericHovercardContext#

A generic hovercard context with a message and icon

Implements

Fields

NameDescription
message
String!

A string describing this context

octicon
String!

An octicon to accompany this context

Gist#

A Gist.

Implements

Fields

NameDescription
comments
GistCommentConnection!

A list of comments associated with the gist

Arguments

NameDescription
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.

createdAt
DateTime!

Identifies the date and time when the object was created.

description
String

The gist description.

files
[GistFile]

The files in this gist.

Arguments

NameDescription
limit
Int

The maximum number of files to return.

oid
GitObjectID

The oid of the files to return

forks
GistConnection!

A list of forks associated with the gist

Arguments

NameDescription
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
GistOrder

Ordering options for gists returned from the connection

id
ID!
isFork
Boolean!

Identifies if the gist is a fork.

isPublic
Boolean!

Whether the gist is public or not.

name
String!

The gist name.

owner
RepositoryOwner

The gist owner.

pushedAt
DateTime

Identifies when the gist was last pushed to.

resourcePath
URI!

The HTML path to this resource.

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.

Arguments

NameDescription
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
StarOrder

Order for connection

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this Gist.

viewerHasStarred
Boolean!

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

GistComment#

Represents a comment on an Gist.

Implements

Fields

NameDescription
author
Actor

The actor who authored the comment.

authorAssociation
CommentAuthorAssociation!

Author's association with the gist.

body
String!

Identifies the comment body.

bodyHTML
HTML!

The body rendered to HTML.

bodyText
String!

The body rendered to text.

createdAt
DateTime!

Identifies the date and time when the object was created.

createdViaEmail
Boolean!

Check if this comment was created via an email reply.

databaseId
Int

Identifies the primary key from the database.

editor
Actor

The actor who edited the comment.

gist
Gist!

The associated gist.

id
ID!
includesCreatedEdit
Boolean!

Check if this comment was edited and includes an edit with the creation data

isMinimized
Boolean!

Returns whether or not a comment has been minimized.

lastEditedAt
DateTime

The moment the editor made the last edit

minimizedReason
String

Returns why the comment was minimized.

publishedAt
DateTime

Identifies when the comment was published at.

updatedAt
DateTime!

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

userContentEdits
UserContentEditConnection

A list of edits to this content.

Arguments

NameDescription
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.

viewerCanDelete
Boolean!

Check if the current viewer can delete this object.

viewerCanMinimize
Boolean!

Check if the current viewer can minimize this object.

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

viewerCannotUpdateReasons
[CommentCannotUpdateReason!]!

Reasons why the current viewer can not update this comment.

viewerDidAuthor
Boolean!

Did the viewer author this comment.

GistCommentConnection#

The connection type for GistComment.

Fields

NameDescription
edges
[GistCommentEdge]

A list of edges.

nodes
[GistComment]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

GistCommentEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
GistComment

The item at the end of the edge.

GistConnection#

The connection type for Gist.

Fields

NameDescription
edges
[GistEdge]

A list of edges.

nodes
[Gist]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

GistEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Gist

The item at the end of the edge.

GistFile#

A file in a gist.

Fields

NameDescription
encodedName
String

The file name encoded to remove characters that are invalid in URL paths.

encoding
String

The gist file encoding.

extension
String

The file extension from the file name.

isImage
Boolean!

Indicates if this file is an image.

isTruncated
Boolean!

Whether the file's contents were truncated.

language
Language

The programming language this file is written in.

name
String

The gist file name.

size
Int

The gist file size in bytes.

text
String

UTF8 text data or null if the file is binary

Arguments

NameDescription
truncate
Int

Optionally truncate the returned file to this length.

GitActor#

Represents an actor in a Git commit (ie. an author or committer).

Fields

NameDescription
avatarUrl
URI!

A URL pointing to the author's public avatar.

Arguments

NameDescription
size
Int

The size of the resulting square image.

date
GitTimestamp

The timestamp of the Git action (authoring or committing).

email
String

The email in the Git commit.

name
String

The name in the Git commit.

user
User

The GitHub user corresponding to the email field. Null if no such user exists.

GitActorConnection#

The connection type for GitActor.

Fields

NameDescription
edges
[GitActorEdge]

A list of edges.

nodes
[GitActor]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

GitActorEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
GitActor

The item at the end of the edge.

GitHubMetadata#

Represents information about the GitHub instance.

Fields

NameDescription
gitHubServicesSha
GitObjectID!

Returns a String that's a SHA of github-services

gitIpAddresses
[String!]

IP addresses that users connect to for git operations

hookIpAddresses
[String!]

IP addresses that service hooks are sent from

importerIpAddresses
[String!]

IP addresses that the importer connects from

isPasswordAuthenticationVerifiable
Boolean!

Whether or not users are verified

pagesIpAddresses
[String!]

IP addresses for GitHub Pages' A records

GpgSignature#

Represents a GPG signature on a Commit or Tag.

Implements

Fields

NameDescription
email
String!

Email used to sign this object.

isValid
Boolean!

True if the signature is valid and verified by GitHub.

keyId
String

Hex-encoded ID of the key that signed this object.

payload
String!

Payload for GPG signing object. Raw ODB object without the signature header.

signature
String!

ASCII-armored signature header from object.

signer
User

GitHub user corresponding to the email signing this commit.

state
GitSignatureState!

The state of this signature. VALID if signature is valid and verified by GitHub, otherwise represents reason why signature is considered invalid.

wasSignedByGitHub
Boolean!

True if the signature was made with GitHub's signing key.

HeadRefDeletedEvent#

Represents a 'head_ref_deleted' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

headRef
Ref

Identifies the Ref associated with the head_ref_deleted event.

headRefName
String!

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

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

HeadRefForcePushedEvent#

Represents a 'head_ref_force_pushed' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

afterCommit
Commit

Identifies the after commit SHA for the 'head_ref_force_pushed' event.

beforeCommit
Commit

Identifies the before commit SHA for the 'head_ref_force_pushed' event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

ref
Ref

Identifies the fully qualified ref name for the 'head_ref_force_pushed' event.

HeadRefRestoredEvent#

Represents a 'head_ref_restored' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

Hovercard#

Detail needed to display a hovercard for a user

Fields

NameDescription
contexts
[HovercardContext!]!

Each of the contexts for this hovercard

ImportProjectPayload#

Autogenerated return type of ImportProject

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

project
Project

The new Project!

InviteEnterpriseAdminPayload#

Autogenerated return type of InviteEnterpriseAdmin

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

invitation
EnterpriseAdministratorInvitation

The created enterprise administrator invitation.

IpAllowListEntry#

An IP address or range of addresses that is allowed to access an owner's resources.

Implements

Fields

NameDescription
allowListValue
String!

A single IP address or range of IP addresses in CIDR notation.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
isActive
Boolean!

Whether the entry is currently active.

name
String

The name of the IP allow list entry.

owner
IpAllowListOwner!

The owner of the IP allow list entry.

updatedAt
DateTime!

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

IpAllowListEntryConnection#

The connection type for IpAllowListEntry.

Fields

NameDescription
edges
[IpAllowListEntryEdge]

A list of edges.

nodes
[IpAllowListEntry]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

IpAllowListEntryEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
IpAllowListEntry

The item at the end of the edge.

Issue#

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

Implements

Fields

NameDescription
activeLockReason
LockReason

Reason that the conversation was locked.

assignees
UserConnection!

A list of Users assigned to this object.

Arguments

NameDescription
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.

author
Actor

The actor who authored the comment.

authorAssociation
CommentAuthorAssociation!

Author's association with the subject of the comment.

body
String!

Identifies the body of the issue.

bodyHTML
HTML!

The body rendered to HTML.

bodyResourcePath
URI!

The http path for this issue body

bodyText
String!

Identifies the body of the issue rendered to text.

bodyUrl
URI!

The http URL for this issue body

closed
Boolean!

true if the object is closed (definition of closed may depend on type)

closedAt
DateTime

Identifies the date and time when the object was closed.

comments
IssueCommentConnection!

A list of comments associated with the Issue.

Arguments

NameDescription
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
IssueCommentOrder

Ordering options for issue comments returned from the connection.

createdAt
DateTime!

Identifies the date and time when the object was created.

createdViaEmail
Boolean!

Check if this comment was created via an email reply.

databaseId
Int

Identifies the primary key from the database.

editor
Actor

The actor who edited the comment.

hovercard
Hovercard!

The hovercard information for this issue

Arguments

NameDescription
includeNotificationContexts
Boolean

Whether or not to include notification contexts

id
ID!
includesCreatedEdit
Boolean!

Check if this comment was edited and includes an edit with the creation data

isPinned
Boolean

Indicates whether or not this issue is currently pinned to the repository issues list

isReadByViewer
Boolean

Is this issue read by the viewer

labels
LabelConnection

A list of labels associated with the object.

Arguments

NameDescription
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
LabelOrder

Ordering options for labels returned from the connection.

lastEditedAt
DateTime

The moment the editor made the last edit

locked
Boolean!

true if the object is locked

milestone
Milestone

Identifies the milestone associated with the issue.

number
Int!

Identifies the issue number.

participants
UserConnection!

A list of Users that are participating in the Issue conversation.

Arguments

NameDescription
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.

projectCards
ProjectCardConnection!

List of project cards associated with this issue.

Arguments

NameDescription
after
String

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

archivedStates
[ProjectCardArchivedState]

A list of archived states to filter the cards 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.

last
Int

Returns the last n elements from the list.

publishedAt
DateTime

Identifies when the comment was published at.

reactionGroups
[ReactionGroup!]

A list of reactions grouped by content left on the subject.

reactions
ReactionConnection!

A list of Reactions left on the Issue.

Arguments

NameDescription
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.

content
ReactionContent

Allows filtering Reactions by emoji.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ReactionOrder

Allows specifying the order in which reactions are returned.

repository
Repository!

The repository associated with this node.

resourcePath
URI!

The HTTP path for this issue

state
IssueState!

Identifies the state of the issue.

timeline
IssueTimelineConnection!
Deprecated: `timeline` will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

A list of events, comments, commits, etc. associated with the issue.

Arguments

NameDescription
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.

since
DateTime

Allows filtering timeline events by a since timestamp.

timelineItems
IssueTimelineItemsConnection!

A list of events, comments, commits, etc. associated with the issue.

Arguments

NameDescription
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.

itemTypes
[IssueTimelineItemsItemType!]

Filter timeline items by type.

last
Int

Returns the last n elements from the list.

since
DateTime

Filter timeline items by a since timestamp.

skip
Int

Skips the first n elements in the list.

title
String!

Identifies the issue title.

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this issue

userContentEdits
UserContentEditConnection

A list of edits to this content.

Arguments

NameDescription
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.

viewerCanReact
Boolean!

Can user react to this subject

viewerCanSubscribe
Boolean!

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

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

viewerCannotUpdateReasons
[CommentCannotUpdateReason!]!

Reasons why the current viewer can not update this comment.

viewerDidAuthor
Boolean!

Did the viewer author this comment.

viewerSubscription
SubscriptionState

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

IssueComment#

Represents a comment on an Issue.

Implements

Fields

NameDescription
author
Actor

The actor who authored the comment.

authorAssociation
CommentAuthorAssociation!

Author's association with the subject of the comment.

body
String!

The body as Markdown.

bodyHTML
HTML!

The body rendered to HTML.

bodyText
String!

The body rendered to text.

createdAt
DateTime!

Identifies the date and time when the object was created.

createdViaEmail
Boolean!

Check if this comment was created via an email reply.

databaseId
Int

Identifies the primary key from the database.

editor
Actor

The actor who edited the comment.

id
ID!
includesCreatedEdit
Boolean!

Check if this comment was edited and includes an edit with the creation data

isMinimized
Boolean!

Returns whether or not a comment has been minimized.

issue
Issue!

Identifies the issue associated with the comment.

lastEditedAt
DateTime

The moment the editor made the last edit

minimizedReason
String

Returns why the comment was minimized.

publishedAt
DateTime

Identifies when the comment was published at.

pullRequest
PullRequest

Returns the pull request associated with the comment, if this comment was made on a pull request.

reactionGroups
[ReactionGroup!]

A list of reactions grouped by content left on the subject.

reactions
ReactionConnection!

A list of Reactions left on the Issue.

Arguments

NameDescription
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.

content
ReactionContent

Allows filtering Reactions by emoji.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ReactionOrder

Allows specifying the order in which reactions are returned.

repository
Repository!

The repository associated with this node.

resourcePath
URI!

The HTTP path for this issue comment

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this issue comment

userContentEdits
UserContentEditConnection

A list of edits to this content.

Arguments

NameDescription
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.

viewerCanDelete
Boolean!

Check if the current viewer can delete this object.

viewerCanMinimize
Boolean!

Check if the current viewer can minimize this object.

viewerCanReact
Boolean!

Can user react to this subject

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

viewerCannotUpdateReasons
[CommentCannotUpdateReason!]!

Reasons why the current viewer can not update this comment.

viewerDidAuthor
Boolean!

Did the viewer author this comment.

IssueCommentConnection#

The connection type for IssueComment.

Fields

NameDescription
edges
[IssueCommentEdge]

A list of edges.

nodes
[IssueComment]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

IssueCommentEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
IssueComment

The item at the end of the edge.

IssueConnection#

The connection type for Issue.

Fields

NameDescription
edges
[IssueEdge]

A list of edges.

nodes
[Issue]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

IssueContributionsByRepository#

This aggregates issues opened by a user within one repository.

Fields

NameDescription
contributions
CreatedIssueContributionConnection!

The issue contributions.

Arguments

NameDescription
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
ContributionOrder

Ordering options for contributions returned from the connection.

repository
Repository!

The repository in which the issues were opened.

IssueEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Issue

The item at the end of the edge.

IssueTemplate#

A repository issue template.

Fields

NameDescription
about
String

The template purpose.

body
String

The suggested issue body.

name
String!

The template name.

title
String

The suggested issue title.

IssueTimelineConnection#

The connection type for IssueTimelineItem.

Fields

NameDescription
edges
[IssueTimelineItemEdge]

A list of edges.

nodes
[IssueTimelineItem]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

IssueTimelineItemEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
IssueTimelineItem

The item at the end of the edge.

IssueTimelineItemsConnection#

The connection type for IssueTimelineItems.

Fields

NameDescription
edges
[IssueTimelineItemsEdge]

A list of edges.

filteredCount
Int!

Identifies the count of items after applying before and after filters.

nodes
[IssueTimelineItems]

A list of nodes.

pageCount
Int!

Identifies the count of items after applying before/after filters and first/last/skip slicing.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

updatedAt
DateTime!

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

IssueTimelineItemsEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
IssueTimelineItems

The item at the end of the edge.

JoinedGitHubContribution#

Represents a user signing up for a GitHub account.

Implements

Fields

NameDescription
isRestricted
Boolean!

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt
DateTime!

When this contribution was made.

resourcePath
URI!

The HTTP path for this contribution.

url
URI!

The HTTP URL for this contribution.

user
User!

The user who made this contribution.

Label#

A label for categorizing Issues or Milestones with a given Repository.

Implements

Fields

NameDescription
color
String!

Identifies the label color.

createdAt
DateTime

Identifies the date and time when the label was created.

description
String

A brief description of this label.

id
ID!
isDefault
Boolean!

Indicates whether or not this is a default label.

issues
IssueConnection!

A list of issues associated with this label.

Arguments

NameDescription
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.

filterBy
IssueFilters

Filtering options for issues returned from the connection.

first
Int

Returns the first n elements from the list.

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 issues returned from the connection.

states
[IssueState!]

A list of states to filter the issues by.

name
String!

Identifies the label name.

pullRequests
PullRequestConnection!

A list of pull requests associated with this label.

Arguments

NameDescription
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.

states
[PullRequestState!]

A list of states to filter the pull requests by.

repository
Repository!

The repository associated with this label.

resourcePath
URI!

The HTTP path for this label.

updatedAt
DateTime

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

url
URI!

The HTTP URL for this label.

LabelConnection#

The connection type for Label.

Fields

NameDescription
edges
[LabelEdge]

A list of edges.

nodes
[Label]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

LabeledEvent#

Represents a 'labeled' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
label
Label!

Identifies the label associated with the 'labeled' event.

labelable
Labelable!

Identifies the Labelable associated with the event.

LabelEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Label

The item at the end of the edge.

Language#

Represents a given language found in repositories.

Implements

Fields

NameDescription
color
String

The color defined for the current language.

id
ID!
name
String!

The name of the current language.

LanguageConnection#

A list of languages associated with the parent.

Fields

NameDescription
edges
[LanguageEdge]

A list of edges.

nodes
[Language]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

totalSize
Int!

The total size in bytes of files written in that language.

LanguageEdge#

Represents the language of a repository.

Fields

NameDescription
cursor
String!
node
Language!
size
Int!

The number of bytes of code written in the language.

License#

A repository's open source license

Implements

Fields

NameDescription
body
String!

The full text of the license

conditions
[LicenseRule]!

The conditions set by the license

description
String

A human-readable description of the license

featured
Boolean!

Whether the license should be featured

hidden
Boolean!

Whether the license should be displayed in license pickers

id
ID!
implementation
String

Instructions on how to implement the license

key
String!

The lowercased SPDX ID of the license

limitations
[LicenseRule]!

The limitations set by the license

name
String!

The license full name specified by https://spdx.org/licenses

nickname
String

Customary short name if applicable (e.g, GPLv3)

permissions
[LicenseRule]!

The permissions set by the license

pseudoLicense
Boolean!

Whether the license is a pseudo-license placeholder (e.g., other, no-license)

spdxId
String

Short identifier specified by https://spdx.org/licenses

url
URI

URL to the license on https://choosealicense.com

LicenseRule#

Describes a License's conditions, permissions, and limitations

Fields

NameDescription
description
String!

A description of the rule

key
String!

The machine-readable rule key

label
String!

The human-readable rule label

LinkRepositoryToProjectPayload#

Autogenerated return type of LinkRepositoryToProject

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

project
Project

The linked Project.

repository
Repository

The linked Repository.

LockedEvent#

Represents a 'locked' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
lockReason
LockReason

Reason that the conversation was locked (optional).

lockable
Lockable!

Object that was locked.

LockLockablePayload#

Autogenerated return type of LockLockable

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

clientMutationId
String

A unique identifier for the client performing the mutation.

lockedRecord
Lockable

The item that was locked.

Mannequin#

A placeholder user for attribution of imported data on GitHub.

Implements

Fields

NameDescription
avatarUrl
URI!

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

Arguments

NameDescription
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.

email
String

The mannequin's email on the source instance.

id
ID!
login
String!

The username of the actor.

resourcePath
URI!

The HTML path to this resource.

updatedAt
DateTime!

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

url
URI!

The URL to this resource.

MarkedAsDuplicateEvent#

Represents a 'marked_as_duplicate' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

canonical
IssueOrPullRequest

The authoritative issue or pull request which has been duplicated by another.

createdAt
DateTime!

Identifies the date and time when the object was created.

duplicate
IssueOrPullRequest

The issue or pull request which has been marked as a duplicate of another.

id
ID!
isCrossRepository
Boolean!

Canonical and duplicate belong to different repositories.

MarketplaceCategory#

A public description of a Marketplace category.

Implements

Fields

NameDescription
description
String

The category's description.

howItWorks
String

The technical description of how apps listed in this category work with GitHub.

id
ID!
name
String!

The category's name.

primaryListingCount
Int!

How many Marketplace listings have this as their primary category.

resourcePath
URI!

The HTTP path for this Marketplace category.

secondaryListingCount
Int!

How many Marketplace listings have this as their secondary category.

slug
String!

The short name of the category used in its URL.

url
URI!

The HTTP URL for this Marketplace category.

MarketplaceListing#

A listing in the GitHub integration marketplace.

Implements

Fields

NameDescription
app
App

The GitHub App this listing represents.

companyUrl
URI

URL to the listing owner's company site.

configurationResourcePath
URI!

The HTTP path for configuring access to the listing's integration or OAuth app

configurationUrl
URI!

The HTTP URL for configuring access to the listing's integration or OAuth app

documentationUrl
URI

URL to the listing's documentation.

extendedDescription
String

The listing's detailed description.

extendedDescriptionHTML
HTML!

The listing's detailed description rendered to HTML.

fullDescription
String!

The listing's introductory description.

fullDescriptionHTML
HTML!

The listing's introductory description rendered to HTML.

hasPublishedFreeTrialPlans
Boolean!

Does this listing have any plans with a free trial?

hasTermsOfService
Boolean!

Does this listing have a terms of service link?

hasVerifiedOwner
Boolean!

Whether the creator of the app is a verified org

howItWorks
String

A technical description of how this app works with GitHub.

howItWorksHTML
HTML!

The listing's technical description rendered to HTML.

id
ID!
installationUrl
URI

URL to install the product to the viewer's account or organization.

installedForViewer
Boolean!

Whether this listing's app has been installed for the current viewer

isArchived
Boolean!

Whether this listing has been removed from the Marketplace.

isDraft
Boolean!

Whether this listing is still an editable draft that has not been submitted for review and is not publicly visible in the Marketplace.

isPaid
Boolean!

Whether the product this listing represents is available as part of a paid plan.

isPublic
Boolean!

Whether this listing has been approved for display in the Marketplace.

isRejected
Boolean!

Whether this listing has been rejected by GitHub for display in the Marketplace.

isUnverified
Boolean!

Whether this listing has been approved for unverified display in the Marketplace.

isUnverifiedPending
Boolean!

Whether this draft listing has been submitted for review for approval to be unverified in the Marketplace.

isVerificationPendingFromDraft
Boolean!

Whether this draft listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

isVerificationPendingFromUnverified
Boolean!

Whether this unverified listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

isVerified
Boolean!

Whether this listing has been approved for verified display in the Marketplace.

logoBackgroundColor
String!

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

logoUrl
URI

URL for the listing's logo image.

Arguments

NameDescription
size
Int

The size in pixels of the resulting square image.

name
String!

The listing's full name.

normalizedShortDescription
String!

The listing's very short description without a trailing period or ampersands.

pricingUrl
URI

URL to the listing's detailed pricing.

primaryCategory
MarketplaceCategory!

The category that best describes the listing.

privacyPolicyUrl
URI!

URL to the listing's privacy policy, may return an empty string for listings that do not require a privacy policy URL.

resourcePath
URI!

The HTTP path for the Marketplace listing.

screenshotUrls
[String]!

The URLs for the listing's screenshots.

secondaryCategory
MarketplaceCategory

An alternate category that describes the listing.

shortDescription
String!

The listing's very short description.

slug
String!

The short name of the listing used in its URL.

statusUrl
URI

URL to the listing's status page.

supportEmail
String

An email address for support for this listing's app.

supportUrl
URI!

Either a URL or an email address for support for this listing's app, may return an empty string for listings that do not require a support URL.

termsOfServiceUrl
URI

URL to the listing's terms of service.

url
URI!

The HTTP URL for the Marketplace listing.

viewerCanAddPlans
Boolean!

Can the current viewer add plans for this Marketplace listing.

viewerCanApprove
Boolean!

Can the current viewer approve this Marketplace listing.

viewerCanDelist
Boolean!

Can the current viewer delist this Marketplace listing.

viewerCanEdit
Boolean!

Can the current viewer edit this Marketplace listing.

viewerCanEditCategories
Boolean!

Can the current viewer edit the primary and secondary category of this Marketplace listing.

viewerCanEditPlans
Boolean!

Can the current viewer edit the plans for this Marketplace listing.

viewerCanRedraft
Boolean!

Can the current viewer return this Marketplace listing to draft state so it becomes editable again.

viewerCanReject
Boolean!

Can the current viewer reject this Marketplace listing by returning it to an editable draft state or rejecting it entirely.

viewerCanRequestApproval
Boolean!

Can the current viewer request this listing be reviewed for display in the Marketplace as verified.

viewerHasPurchased
Boolean!

Indicates whether the current user has an active subscription to this Marketplace listing.

viewerHasPurchasedForAllOrganizations
Boolean!

Indicates if the current user has purchased a subscription to this Marketplace listing for all of the organizations the user owns.

viewerIsListingAdmin
Boolean!

Does the current viewer role allow them to administer this Marketplace listing.

MarketplaceListingConnection#

Look up Marketplace Listings

Fields

NameDescription
edges
[MarketplaceListingEdge]

A list of edges.

nodes
[MarketplaceListing]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

MarketplaceListingEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
MarketplaceListing

The item at the end of the edge.

MarkFileAsViewedPayload#

Autogenerated return type of MarkFileAsViewed

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The updated pull request.

MarkPullRequestReadyForReviewPayload#

Autogenerated return type of MarkPullRequestReadyForReview

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The pull request that is ready for review.

MembersCanDeleteReposClearAuditEntry#

Audit log entry for a members_can_delete_repos.clear event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

enterpriseResourcePath
URI

The HTTP path for this enterprise.

enterpriseSlug
String

The slug of the enterprise.

enterpriseUrl
URI

The HTTP URL for this enterprise.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

MembersCanDeleteReposDisableAuditEntry#

Audit log entry for a members_can_delete_repos.disable event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

enterpriseResourcePath
URI

The HTTP path for this enterprise.

enterpriseSlug
String

The slug of the enterprise.

enterpriseUrl
URI

The HTTP URL for this enterprise.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

MembersCanDeleteReposEnableAuditEntry#

Audit log entry for a members_can_delete_repos.enable event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

enterpriseResourcePath
URI

The HTTP path for this enterprise.

enterpriseSlug
String

The slug of the enterprise.

enterpriseUrl
URI

The HTTP URL for this enterprise.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

MentionedEvent#

Represents a 'mentioned' event on a given issue or pull request.

Implements

Fields

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.

id
ID!

MergeBranchPayload#

Autogenerated return type of MergeBranch

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

mergeCommit
Commit

The resulting merge Commit.

MergedEvent#

Represents a 'merged' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

commit
Commit

Identifies the commit associated with the merge event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
mergeRef
Ref

Identifies the Ref associated with the merge event.

mergeRefName
String!

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

pullRequest
PullRequest!

PullRequest referenced by event.

resourcePath
URI!

The HTTP path for this merged event.

url
URI!

The HTTP URL for this merged event.

MergePullRequestPayload#

Autogenerated return type of MergePullRequest

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The pull request that was merged.

Milestone#

Represents a Milestone object on a given repository.

Implements

Fields

NameDescription
closed
Boolean!

true if the object is closed (definition of closed may depend on type)

closedAt
DateTime

Identifies the date and time when the object was closed.

createdAt
DateTime!

Identifies the date and time when the object was created.

creator
Actor

Identifies the actor who created the milestone.

description
String

Identifies the description of the milestone.

dueOn
DateTime

Identifies the due date of the milestone.

id
ID!
issues
IssueConnection!

A list of issues associated with the milestone.

Arguments

NameDescription
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.

filterBy
IssueFilters

Filtering options for issues returned from the connection.

first
Int

Returns the first n elements from the list.

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 issues returned from the connection.

states
[IssueState!]

A list of states to filter the issues by.

number
Int!

Identifies the number of the milestone.

progressPercentage
Float!

Identifies the percentage complete for the milestone

pullRequests
PullRequestConnection!

A list of pull requests associated with the milestone.

Arguments

NameDescription
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.

states
[PullRequestState!]

A list of states to filter the pull requests by.

repository
Repository!

The repository associated with this milestone.

resourcePath
URI!

The HTTP path for this milestone

state
MilestoneState!

Identifies the state of the milestone.

title
String!

Identifies the title of the milestone.

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this milestone

MilestoneConnection#

The connection type for Milestone.

Fields

NameDescription
edges
[MilestoneEdge]

A list of edges.

nodes
[Milestone]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

MilestonedEvent#

Represents a 'milestoned' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
milestoneTitle
String!

Identifies the milestone title associated with the 'milestoned' event.

subject
MilestoneItem!

Object referenced by event.

MilestoneEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Milestone

The item at the end of the edge.

MinimizeCommentPayload#

Autogenerated return type of MinimizeComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

minimizedComment
Minimizable

The comment that was minimized.

MovedColumnsInProjectEvent#

Represents a 'moved_columns_in_project' event on a given issue or pull request.

Implements

Fields

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.

id
ID!
previousProjectColumnName
String!

Column name the issue or pull request was moved from.

project
Project

Project referenced by event.

projectCard
ProjectCard

Project card referenced by this project event.

projectColumnName
String!

Column name the issue or pull request was moved to.

MoveProjectCardPayload#

Autogenerated return type of MoveProjectCard

Fields

NameDescription
cardEdge
ProjectCardEdge

The new edge of the moved card.

clientMutationId
String

A unique identifier for the client performing the mutation.

MoveProjectColumnPayload#

Autogenerated return type of MoveProjectColumn

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

columnEdge
ProjectColumnEdge

The new edge of the moved column.

OauthApplicationCreateAuditEntry#

Audit log entry for a oauth_application.create event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

applicationUrl
URI

The application URL of the OAuth Application.

callbackUrl
URI

The callback URL of the OAuth Application.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
oauthApplicationName
String

The name of the OAuth Application.

oauthApplicationResourcePath
URI

The HTTP path for the OAuth Application

oauthApplicationUrl
URI

The HTTP URL for the OAuth Application

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

rateLimit
Int

The rate limit of the OAuth Application.

state
OauthApplicationCreateAuditEntryState

The state of the OAuth Application.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgAddBillingManagerAuditEntry#

Audit log entry for a org.add_billing_manager

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
invitationEmail
String

The email address used to invite a billing manager for the organization.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgAddMemberAuditEntry#

Audit log entry for a org.add_member

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

permission
OrgAddMemberAuditEntryPermission

The permission level of the member added to the organization.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

Organization#

An account on GitHub, with one or more owners, that has repositories, members and teams.

Implements

Fields

NameDescription
anyPinnableItems
Boolean!

Determine if this repository owner has any items that can be pinned to their profile.

Arguments

NameDescription
type
PinnableItemType

Filter to only a particular kind of pinnable item.

auditLog
OrganizationAuditEntryConnection!

Audit log entries of the organization

Arguments

NameDescription
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
AuditLogOrder

Ordering options for the returned audit log entries.

query
String

The query string to filter audit entries

avatarUrl
URI!

A URL pointing to the organization's public avatar.

Arguments

NameDescription
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.

description
String

The organization's public profile description.

descriptionHTML
String

The organization's public profile description rendered to HTML.

domains
VerifiableDomainConnection

A list of domains owned by the organization.

Arguments

NameDescription
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.

isVerified
Boolean

Filter by if the domain is verified.

last
Int

Returns the last n elements from the list.

orderBy
VerifiableDomainOrder

Ordering options for verifiable domains returned.

email
String

The organization's public email.

hasSponsorsListing
Boolean!

True if this user/organization has a GitHub Sponsors listing.

id
ID!
interactionAbility
RepositoryInteractionAbility

The interaction ability settings for this organization.

ipAllowListEnabledSetting
IpAllowListEnabledSettingValue!

The setting value for whether the organization has an IP allow list enabled.

ipAllowListEntries
IpAllowListEntryConnection!

The IP addresses that are allowed to access resources owned by the organization.

Arguments

NameDescription
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
IpAllowListEntryOrder

Ordering options for IP allow list entries returned.

isSponsoredBy
Boolean!

Check if the given account is sponsoring this user/organization.

Arguments

NameDescription
accountLogin
String!

The target account's login.

isSponsoringViewer
Boolean!

True if the viewer is sponsored by this user/organization.

isVerified
Boolean!

Whether the organization has verified its profile email and website.

itemShowcase
ProfileItemShowcase!

Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity.

location
String

The organization's public profile location.

login
String!

The organization's login name.

memberStatuses
UserStatusConnection!

Get the status messages members of this entity have set that are either public or visible only to the organization.

Arguments

NameDescription
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
UserStatusOrder

Ordering options for user statuses returned from the connection.

membersWithRole
OrganizationMemberConnection!

A list of users who are members of this organization.

Arguments

NameDescription
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.

name
String

The organization's public profile name.

newTeamResourcePath
URI!

The HTTP path creating a new team

newTeamUrl
URI!

The HTTP URL creating a new team

notificationDeliveryRestrictionEnabledSetting
NotificationRestrictionSettingValue!

Indicates if email notification delivery for this organization is restricted to verified domains.

organizationBillingEmail
String

The billing email for the organization.

packages
PackageConnection!

A list of packages under the owner.

Arguments

NameDescription
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.

names
[String]

Find packages by their names.

orderBy
PackageOrder

Ordering of the returned packages.

packageType
PackageType

Filter registry package by type.

repositoryId
ID

Find packages in a repository by ID.

pendingMembers
UserConnection!

A list of users who have been invited to join this organization.

Arguments

NameDescription
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.

pinnableItems
PinnableItemConnection!

A list of repositories and gists this profile owner can pin to their profile.

Arguments

NameDescription
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.

types
[PinnableItemType!]

Filter the types of pinnable items that are returned.

pinnedItems
PinnableItemConnection!

A list of repositories and gists this profile owner has pinned to their profile

Arguments

NameDescription
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.

types
[PinnableItemType!]

Filter the types of pinned items that are returned.

pinnedItemsRemaining
Int!

Returns how many more items this profile owner can pin to their profile.

project
Project

Find project by number.

Arguments

NameDescription
number
Int!

The project number to find.

projects
ProjectConnection!

A list of projects under the owner.

Arguments

NameDescription
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
ProjectOrder

Ordering options for projects returned from the connection

search
String

Query to search projects by, currently only searching by name.

states
[ProjectState!]

A list of states to filter the projects by.

projectsResourcePath
URI!

The HTTP path listing organization's projects

projectsUrl
URI!

The HTTP URL listing organization's projects

repositories
RepositoryConnection!

A list of repositories that the user owns.

Arguments

NameDescription
affiliations
[RepositoryAffiliation]

Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.

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.

isFork
Boolean

If non-null, filters repositories according to whether they are forks of another repository

isLocked
Boolean

If non-null, filters repositories according to whether they have been locked

last
Int

Returns the last n elements from the list.

orderBy
RepositoryOrder

Ordering options for repositories returned from the connection

ownerAffiliations
[RepositoryAffiliation]

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

privacy
RepositoryPrivacy

If non-null, filters repositories according to privacy

repository
Repository

Find Repository.

Arguments

NameDescription
name
String!

Name of Repository to find.

requiresTwoFactorAuthentication
Boolean

When true the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

resourcePath
URI!

The HTTP path for this organization.

samlIdentityProvider
OrganizationIdentityProvider

The Organization's SAML identity providers

sponsorsListing
SponsorsListing

The GitHub Sponsors listing for this user or organization.

sponsorshipForViewerAsSponsor
Sponsorship

The viewer's sponsorship of this entity.

sponsorshipsAsMaintainer
SponsorshipConnection!

This object's sponsorships as the maintainer.

Arguments

NameDescription
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.

includePrivate
Boolean

Whether or not to include private sponsorships in the result set

last
Int

Returns the last n elements from the list.

orderBy
SponsorshipOrder

Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.

sponsorshipsAsSponsor
SponsorshipConnection!

This object's sponsorships as the sponsor.

Arguments

NameDescription
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
SponsorshipOrder

Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.

team
Team

Find an organization's team by its slug.

Arguments

NameDescription
slug
String!

The name or slug of the team to find.

teams
TeamConnection!

A list of teams in this organization.

Arguments

NameDescription
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.

ldapMapped
Boolean

If true, filters teams that are mapped to an LDAP Group (Enterprise only)

orderBy
TeamOrder

Ordering options for teams returned from the connection

privacy
TeamPrivacy

If non-null, filters teams according to privacy

query
String

If non-null, filters teams with query on team name and team slug

role
TeamRole

If non-null, filters teams according to whether the viewer is an admin or member on team

rootTeamsOnly
Boolean

If true, restrict to only root teams

userLogins
[String!]

User logins to filter by

teamsResourcePath
URI!

The HTTP path listing organization's teams

teamsUrl
URI!

The HTTP URL listing organization's teams

twitterUsername
String

The organization's Twitter username.

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this organization.

viewerCanAdminister
Boolean!

Organization is adminable by the viewer.

viewerCanChangePinnedItems
Boolean!

Can the viewer pin repositories and gists to the profile?

viewerCanCreateProjects
Boolean!

Can the current viewer create new projects on this owner.

viewerCanCreateRepositories
Boolean!

Viewer can create repositories on this organization

viewerCanCreateTeams
Boolean!

Viewer can create teams on this organization.

viewerCanSponsor
Boolean!

Whether or not the viewer is able to sponsor this user/organization.

viewerIsAMember
Boolean!

Viewer is an active member of this organization.

viewerIsSponsoring
Boolean!

True if the viewer is sponsoring this user/organization.

websiteUrl
URI

The organization's public profile URL.

OrganizationAuditEntryConnection#

The connection type for OrganizationAuditEntry.

Fields

NameDescription
edges
[OrganizationAuditEntryEdge]

A list of edges.

nodes
[OrganizationAuditEntry]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrganizationAuditEntryEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
OrganizationAuditEntry

The item at the end of the edge.

OrganizationConnection#

The connection type for Organization.

Fields

NameDescription
edges
[OrganizationEdge]

A list of edges.

nodes
[Organization]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrganizationEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Organization

The item at the end of the edge.

OrganizationIdentityProvider#

An Identity Provider configured to provision SAML and SCIM identities for Organizations

Implements

Fields

NameDescription
digestMethod
URI

The digest algorithm used to sign SAML requests for the Identity Provider.

externalIdentities
ExternalIdentityConnection!

External Identities provisioned by this Identity Provider

Arguments

NameDescription
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.

id
ID!
idpCertificate
X509Certificate

The x509 certificate used by the Identity Provider to sign assertions and responses.

issuer
String

The Issuer Entity ID for the SAML Identity Provider

organization
Organization

Organization this Identity Provider belongs to

signatureMethod
URI

The signature algorithm used to sign SAML requests for the Identity Provider.

ssoUrl
URI

The URL endpoint for the Identity Provider's SAML SSO.

OrganizationInvitation#

An Invitation for a user to an organization.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

email
String

The email address of the user invited to the organization.

id
ID!
invitationType
OrganizationInvitationType!

The type of invitation that was sent (e.g. email, user).

invitee
User

The user who was invited to the organization.

inviter
User!

The user who created the invitation.

organization
Organization!

The organization the invite is for

role
OrganizationInvitationRole!

The user's pending role in the organization (e.g. member, owner).

OrganizationInvitationConnection#

The connection type for OrganizationInvitation.

Fields

NameDescription
edges
[OrganizationInvitationEdge]

A list of edges.

nodes
[OrganizationInvitation]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrganizationInvitationEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
OrganizationInvitation

The item at the end of the edge.

OrganizationMemberConnection#

The connection type for User.

Fields

NameDescription
edges
[OrganizationMemberEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrganizationMemberEdge#

Represents a user within an organization.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

hasTwoFactorEnabled
Boolean

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

node
User

The item at the end of the edge.

role
OrganizationMemberRole

The role this user has in the organization.

OrganizationsHovercardContext#

An organization list hovercard context

Implements

Fields

NameDescription
message
String!

A string describing this context

octicon
String!

An octicon to accompany this context

relevantOrganizations
OrganizationConnection!

Organizations this user is a member of that are relevant

Arguments

NameDescription
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.

totalOrganizationCount
Int!

The total number of organizations this user is in

OrganizationTeamsHovercardContext#

An organization teams hovercard context

Implements

Fields

NameDescription
message
String!

A string describing this context

octicon
String!

An octicon to accompany this context

relevantTeams
TeamConnection!

Teams in this organization the user is a member of that are relevant

Arguments

NameDescription
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.

teamsResourcePath
URI!

The path for the full team list for this user

teamsUrl
URI!

The URL for the full team list for this user

totalTeamCount
Int!

The total number of teams the user is on in the organization

OrgBlockUserAuditEntry#

Audit log entry for a org.block_user

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

blockedUser
User

The blocked user.

blockedUserName
String

The username of the blocked user.

blockedUserResourcePath
URI

The HTTP path for the blocked user.

blockedUserUrl
URI

The HTTP URL for the blocked user.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgConfigDisableCollaboratorsOnlyAuditEntry#

Audit log entry for a org.config.disable_collaborators_only event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgConfigEnableCollaboratorsOnlyAuditEntry#

Audit log entry for a org.config.enable_collaborators_only event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgCreateAuditEntry#

Audit log entry for a org.create event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

billingPlan
OrgCreateAuditEntryBillingPlan

The billing plan for the Organization.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgDisableOauthAppRestrictionsAuditEntry#

Audit log entry for a org.disable_oauth_app_restrictions event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgDisableSamlAuditEntry#

Audit log entry for a org.disable_saml event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

digestMethodUrl
URI

The SAML provider's digest algorithm URL.

id
ID!
issuerUrl
URI

The SAML provider's issuer URL.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

signatureMethodUrl
URI

The SAML provider's signature algorithm URL.

singleSignOnUrl
URI

The SAML provider's single sign-on URL.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgDisableTwoFactorRequirementAuditEntry#

Audit log entry for a org.disable_two_factor_requirement event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgEnableOauthAppRestrictionsAuditEntry#

Audit log entry for a org.enable_oauth_app_restrictions event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgEnableSamlAuditEntry#

Audit log entry for a org.enable_saml event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

digestMethodUrl
URI

The SAML provider's digest algorithm URL.

id
ID!
issuerUrl
URI

The SAML provider's issuer URL.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

signatureMethodUrl
URI

The SAML provider's signature algorithm URL.

singleSignOnUrl
URI

The SAML provider's single sign-on URL.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgEnableTwoFactorRequirementAuditEntry#

Audit log entry for a org.enable_two_factor_requirement event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgInviteMemberAuditEntry#

Audit log entry for a org.invite_member event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

email
String

The email address of the organization invitation.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationInvitation
OrganizationInvitation

The organization invitation.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgInviteToBusinessAuditEntry#

Audit log entry for a org.invite_to_business event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

enterpriseResourcePath
URI

The HTTP path for this enterprise.

enterpriseSlug
String

The slug of the enterprise.

enterpriseUrl
URI

The HTTP URL for this enterprise.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgOauthAppAccessApprovedAuditEntry#

Audit log entry for a org.oauth_app_access_approved event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
oauthApplicationName
String

The name of the OAuth Application.

oauthApplicationResourcePath
URI

The HTTP path for the OAuth Application

oauthApplicationUrl
URI

The HTTP URL for the OAuth Application

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgOauthAppAccessDeniedAuditEntry#

Audit log entry for a org.oauth_app_access_denied event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
oauthApplicationName
String

The name of the OAuth Application.

oauthApplicationResourcePath
URI

The HTTP path for the OAuth Application

oauthApplicationUrl
URI

The HTTP URL for the OAuth Application

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgOauthAppAccessRequestedAuditEntry#

Audit log entry for a org.oauth_app_access_requested event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
oauthApplicationName
String

The name of the OAuth Application.

oauthApplicationResourcePath
URI

The HTTP path for the OAuth Application

oauthApplicationUrl
URI

The HTTP URL for the OAuth Application

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgRemoveBillingManagerAuditEntry#

Audit log entry for a org.remove_billing_manager event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

reason
OrgRemoveBillingManagerAuditEntryReason

The reason for the billing manager being removed.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgRemoveMemberAuditEntry#

Audit log entry for a org.remove_member event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
membershipTypes
[OrgRemoveMemberAuditEntryMembershipType!]

The types of membership the member has with the organization.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

reason
OrgRemoveMemberAuditEntryReason

The reason for the member being removed.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgRemoveOutsideCollaboratorAuditEntry#

Audit log entry for a org.remove_outside_collaborator event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
membershipTypes
[OrgRemoveOutsideCollaboratorAuditEntryMembershipType!]

The types of membership the outside collaborator has with the organization.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

reason
OrgRemoveOutsideCollaboratorAuditEntryReason

The reason for the outside collaborator being removed from the Organization.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgRestoreMemberAuditEntry#

Audit log entry for a org.restore_member event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

restoredCustomEmailRoutingsCount
Int

The number of custom email routings for the restored member.

restoredIssueAssignmentsCount
Int

The number of issue assignments for the restored member.

restoredMemberships
[OrgRestoreMemberAuditEntryMembership!]

Restored organization membership objects.

restoredMembershipsCount
Int

The number of restored memberships.

restoredRepositoriesCount
Int

The number of repositories of the restored member.

restoredRepositoryStarsCount
Int

The number of starred repositories for the restored member.

restoredRepositoryWatchesCount
Int

The number of watched repositories for the restored member.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgRestoreMemberMembershipOrganizationAuditEntryData#

Metadata for an organization membership for org.restore_member actions

Implements

Fields

NameDescription
organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

OrgRestoreMemberMembershipRepositoryAuditEntryData#

Metadata for a repository membership for org.restore_member actions

Implements

Fields

NameDescription
repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

OrgRestoreMemberMembershipTeamAuditEntryData#

Metadata for a team membership for org.restore_member actions

Implements

Fields

NameDescription
team
Team

The team associated with the action

teamName
String

The name of the team

teamResourcePath
URI

The HTTP path for this team

teamUrl
URI

The HTTP URL for this team

OrgUnblockUserAuditEntry#

Audit log entry for a org.unblock_user

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

blockedUser
User

The user being unblocked by the organization.

blockedUserName
String

The username of the blocked user.

blockedUserResourcePath
URI

The HTTP path for the blocked user.

blockedUserUrl
URI

The HTTP URL for the blocked user.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgUpdateDefaultRepositoryPermissionAuditEntry#

Audit log entry for a org.update_default_repository_permission

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

permission
OrgUpdateDefaultRepositoryPermissionAuditEntryPermission

The new default repository permission level for the organization.

permissionWas
OrgUpdateDefaultRepositoryPermissionAuditEntryPermission

The former default repository permission level for the organization.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgUpdateMemberAuditEntry#

Audit log entry for a org.update_member event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

permission
OrgUpdateMemberAuditEntryPermission

The new member permission level for the organization.

permissionWas
OrgUpdateMemberAuditEntryPermission

The former member permission level for the organization.

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

OrgUpdateMemberRepositoryCreationPermissionAuditEntry#

Audit log entry for a org.update_member_repository_creation_permission event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

canCreateRepositories
Boolean

Can members create repositories in the organization.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

visibility
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility

The permission for visibility level of repositories for this organization.

OrgUpdateMemberRepositoryInvitationPermissionAuditEntry#

Audit log entry for a org.update_member_repository_invitation_permission event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

canInviteOutsideCollaboratorsToRepositories
Boolean

Can outside collaborators be invited to repositories in the organization.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

Package#

Information for an uploaded package.

Implements

Fields

NameDescription
id
ID!
latestVersion
PackageVersion

Find the latest version for the package.

name
String!

Identifies the name of the package.

packageType
PackageType!

Identifies the type of the package.

repository
Repository

The repository this package belongs to.

statistics
PackageStatistics

Statistics about package activity.

version
PackageVersion

Find package version by version string.

Arguments

NameDescription
version
String!

The package version.

versions
PackageVersionConnection!

list of versions for this package

Arguments

NameDescription
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
PackageVersionOrder

Ordering of the returned packages.

PackageConnection#

The connection type for Package.

Fields

NameDescription
edges
[PackageEdge]

A list of edges.

nodes
[Package]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PackageEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Package

The item at the end of the edge.

PackageFile#

A file in a package version.

Implements

Fields

NameDescription
id
ID!
md5
String

MD5 hash of the file.

name
String!

Name of the file.

packageVersion
PackageVersion

The package version this file belongs to.

sha1
String

SHA1 hash of the file.

sha256
String

SHA256 hash of the file.

size
Int

Size of the file in bytes.

updatedAt
DateTime!

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

url
URI

URL to download the asset.

PackageFileConnection#

The connection type for PackageFile.

Fields

NameDescription
edges
[PackageFileEdge]

A list of edges.

nodes
[PackageFile]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PackageFileEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PackageFile

The item at the end of the edge.

PackageStatistics#

Represents a object that contains package activity statistics such as downloads.

Fields

NameDescription
downloadsTotalCount
Int!

Number of times the package was downloaded since it was created.

PackageTag#

A version tag contains the mapping between a tag name and a version.

Implements

Fields

NameDescription
id
ID!
name
String!

Identifies the tag name of the version.

version
PackageVersion

Version that the tag is associated with.

PackageVersion#

Information about a specific package version.

Implements

Fields

NameDescription
files
PackageFileConnection!

List of files associated with this package version

Arguments

NameDescription
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
PackageFileOrder

Ordering of the returned package files.

id
ID!
package
Package

The package associated with this version.

platform
String

The platform this version was built for.

preRelease
Boolean!

Whether or not this version is a pre-release.

readme
String

The README of this package version.

release
Release

The release associated with this package version.

statistics
PackageVersionStatistics

Statistics about package activity.

summary
String

The package version summary.

version
String!

The version string.

PackageVersionConnection#

The connection type for PackageVersion.

Fields

NameDescription
edges
[PackageVersionEdge]

A list of edges.

nodes
[PackageVersion]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PackageVersionEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PackageVersion

The item at the end of the edge.

PackageVersionStatistics#

Represents a object that contains package version activity statistics such as downloads.

Fields

NameDescription
downloadsTotalCount
Int!

Number of times the package was downloaded since it was created.

PageInfo#

Information about pagination in a connection.

Fields

NameDescription
endCursor
String

When paginating forwards, the cursor to continue.

hasNextPage
Boolean!

When paginating forwards, are there more items?

hasPreviousPage
Boolean!

When paginating backwards, are there more items?

startCursor
String

When paginating backwards, the cursor to continue.

PermissionSource#

A level of permission and source for a user's access to a repository.

Fields

NameDescription
organization
Organization!

The organization the repository belongs to.

permission
DefaultRepositoryPermissionField!

The level of access this source has granted to the user.

source
PermissionGranter!

The source of this permission.

PinIssuePayload#

Autogenerated return type of PinIssue

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issue
Issue

The issue that was pinned

PinnableItemConnection#

The connection type for PinnableItem.

Fields

NameDescription
edges
[PinnableItemEdge]

A list of edges.

nodes
[PinnableItem]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PinnableItemEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PinnableItem

The item at the end of the edge.

PinnedEvent#

Represents a 'pinned' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
issue
Issue!

Identifies the issue associated with the event.

PinnedIssue#

A Pinned Issue is a issue pinned to a repository's index page.

Implements

Fields

NameDescription
databaseId
Int

Identifies the primary key from the database.

id
ID!
issue
Issue!

The issue that was pinned.

pinnedBy
Actor!

The actor that pinned this issue.

repository
Repository!

The repository that this issue was pinned to.

PinnedIssueConnection#

The connection type for PinnedIssue.

Fields

NameDescription
edges
[PinnedIssueEdge]

A list of edges.

nodes
[PinnedIssue]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PinnedIssueEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PinnedIssue

The item at the end of the edge.

PrivateRepositoryForkingDisableAuditEntry#

Audit log entry for a private_repository_forking.disable event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

enterpriseResourcePath
URI

The HTTP path for this enterprise.

enterpriseSlug
String

The slug of the enterprise.

enterpriseUrl
URI

The HTTP URL for this enterprise.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

PrivateRepositoryForkingEnableAuditEntry#

Audit log entry for a private_repository_forking.enable event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

enterpriseResourcePath
URI

The HTTP path for this enterprise.

enterpriseSlug
String

The slug of the enterprise.

enterpriseUrl
URI

The HTTP URL for this enterprise.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

ProfileItemShowcase#

A curatable list of repositories relating to a repository owner, which defaults to showing the most popular repositories they own.

Fields

NameDescription
hasPinnedItems
Boolean!

Whether or not the owner has pinned any repositories or gists.

items
PinnableItemConnection!

The repositories and gists in the showcase. If the profile owner has any pinned items, those will be returned. Otherwise, the profile owner's popular repositories will be returned.

Arguments

NameDescription
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.

Project#

Projects manage issues, pull requests and notes within a project owner.

Implements

Fields

NameDescription
body
String

The project's description body.

bodyHTML
HTML!

The projects description body rendered to HTML.

closed
Boolean!

true if the object is closed (definition of closed may depend on type)

closedAt
DateTime

Identifies the date and time when the object was closed.

columns
ProjectColumnConnection!

List of columns in the project

Arguments

NameDescription
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.

createdAt
DateTime!

Identifies the date and time when the object was created.

creator
Actor

The actor who originally created the project.

databaseId
Int

Identifies the primary key from the database.

id
ID!
name
String!

The project's name.

number
Int!

The project's number.

owner
ProjectOwner!

The project's owner. Currently limited to repositories, organizations, and users.

pendingCards
ProjectCardConnection!

List of pending cards in this project

Arguments

NameDescription
after
String

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

archivedStates
[ProjectCardArchivedState]

A list of archived states to filter the cards 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.

last
Int

Returns the last n elements from the list.

progress
ProjectProgress!

Project progress details.

resourcePath
URI!

The HTTP path for this project

state
ProjectState!

Whether the project is open or closed.

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this project

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

ProjectCard#

A card in a project.

Implements

Fields

NameDescription
column
ProjectColumn

The project column this card is associated under. A card may only belong to one project column at a time. The column field will be null if the card is created in a pending state and has yet to be associated with a column. Once cards are associated with a column, they will not become pending in the future.

content
ProjectCardItem

The card content item

createdAt
DateTime!

Identifies the date and time when the object was created.

creator
Actor

The actor who created this card

databaseId
Int

Identifies the primary key from the database.

id
ID!
isArchived
Boolean!

Whether the card is archived

note
String

The card note

project
Project!

The project that contains this card.

resourcePath
URI!

The HTTP path for this card

state
ProjectCardState

The state of ProjectCard

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this card

ProjectCardConnection#

The connection type for ProjectCard.

Fields

NameDescription
edges
[ProjectCardEdge]

A list of edges.

nodes
[ProjectCard]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ProjectCardEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
ProjectCard

The item at the end of the edge.

ProjectColumn#

A column inside a project.

Implements

Fields

NameDescription
cards
ProjectCardConnection!

List of cards in the column

Arguments

NameDescription
after
String

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

archivedStates
[ProjectCardArchivedState]

A list of archived states to filter the cards 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.

last
Int

Returns the last n elements from the list.

createdAt
DateTime!

Identifies the date and time when the object was created.

databaseId
Int

Identifies the primary key from the database.

id
ID!
name
String!

The project column's name.

project
Project!

The project that contains this column.

purpose
ProjectColumnPurpose

The semantic purpose of the column

resourcePath
URI!

The HTTP path for this project column

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this project column

ProjectColumnConnection#

The connection type for ProjectColumn.

Fields

NameDescription
edges
[ProjectColumnEdge]

A list of edges.

nodes
[ProjectColumn]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ProjectColumnEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
ProjectColumn

The item at the end of the edge.

ProjectConnection#

A list of projects associated with the owner.

Fields

NameDescription
edges
[ProjectEdge]

A list of edges.

nodes
[Project]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ProjectEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Project

The item at the end of the edge.

ProjectProgress#

Project progress stats.

Fields

NameDescription
doneCount
Int!

The number of done cards.

donePercentage
Float!

The percentage of done cards.

enabled
Boolean!

Whether progress tracking is enabled and cards with purpose exist for this project

inProgressCount
Int!

The number of in-progress cards.

inProgressPercentage
Float!

The percentage of in-progress cards.

todoCount
Int!

The number of to do cards.

todoPercentage
Float!

The percentage of to do cards.

PublicKey#

A user's public key.

Implements

Fields

NameDescription
accessedAt
DateTime

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

createdAt
DateTime

Identifies the date and time when the key was created. Keys created before March 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

fingerprint
String!

The fingerprint for this PublicKey.

id
ID!
isReadOnly
Boolean

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

key
String!

The public key string.

updatedAt
DateTime

Identifies the date and time when the key was updated. Keys created before March 5th, 2014 may have inaccurate values. Values will be null for keys not owned by the user.

PublicKeyConnection#

The connection type for PublicKey.

Fields

NameDescription
edges
[PublicKeyEdge]

A list of edges.

nodes
[PublicKey]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PublicKeyEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PublicKey

The item at the end of the edge.

PullRequest#

A repository pull request.

Implements

Fields

NameDescription
activeLockReason
LockReason

Reason that the conversation was locked.

additions
Int!

The number of additions in this pull request.

assignees
UserConnection!

A list of Users assigned to this object.

Arguments

NameDescription
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.

author
Actor

The actor who authored the comment.

authorAssociation
CommentAuthorAssociation!

Author's association with the subject of the comment.

autoMergeRequest
AutoMergeRequest

Returns the auto-merge request object if one exists for this pull request.

baseRef
Ref

Identifies the base Ref associated with the pull request.

baseRefName
String!

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

baseRefOid
GitObjectID!

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

baseRepository
Repository

The repository associated with this pull request's base Ref.

body
String!

The body as Markdown.

bodyHTML
HTML!

The body rendered to HTML.

bodyText
String!

The body rendered to text.

canBeRebased
Boolean!

Whether or not the pull request is rebaseable.

changedFiles
Int!

The number of changed files in this pull request.

checksResourcePath
URI!

The HTTP path for the checks of this pull request.

checksUrl
URI!

The HTTP URL for the checks of this pull request.

closed
Boolean!

true if the pull request is closed

closedAt
DateTime

Identifies the date and time when the object was closed.

comments
IssueCommentConnection!

A list of comments associated with the pull request.

Arguments

NameDescription
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
IssueCommentOrder

Ordering options for issue comments returned from the connection.

commits
PullRequestCommitConnection!

A list of commits present in this pull request's head branch not present in the base branch.

Arguments

NameDescription
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.

createdAt
DateTime!

Identifies the date and time when the object was created.

createdViaEmail
Boolean!

Check if this comment was created via an email reply.

databaseId
Int

Identifies the primary key from the database.

deletions
Int!

The number of deletions in this pull request.

editor
Actor

The actor who edited this pull request's body.

files
PullRequestChangedFileConnection

Lists the files changed within this pull request.

Arguments

NameDescription
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.

headRef
Ref

Identifies the head Ref associated with the pull request.

headRefName
String!

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

headRefOid
GitObjectID!

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

headRepository
Repository

The repository associated with this pull request's head Ref.

headRepositoryOwner
RepositoryOwner

The owner of the repository associated with this pull request's head Ref.

hovercard
Hovercard!

The hovercard information for this issue

Arguments

NameDescription
includeNotificationContexts
Boolean

Whether or not to include notification contexts

id
ID!
includesCreatedEdit
Boolean!

Check if this comment was edited and includes an edit with the creation data

isCrossRepository
Boolean!

The head and base repositories are different.

isDraft
Boolean!

Identifies if the pull request is a draft.

isReadByViewer
Boolean

Is this pull request read by the viewer

labels
LabelConnection

A list of labels associated with the object.

Arguments

NameDescription
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
LabelOrder

Ordering options for labels returned from the connection.

lastEditedAt
DateTime

The moment the editor made the last edit

latestOpinionatedReviews
PullRequestReviewConnection

A list of latest reviews per user associated with the pull request.

Arguments

NameDescription
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.

writersOnly
Boolean

Only return reviews from user who have write access to the repository

latestReviews
PullRequestReviewConnection

A list of latest reviews per user associated with the pull request that are not also pending review.

Arguments

NameDescription
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.

locked
Boolean!

true if the pull request is locked

maintainerCanModify
Boolean!

Indicates whether maintainers can modify the pull request.

mergeCommit
Commit

The commit that was created when this pull request was merged.

mergeStateStatus
MergeStateStatus!

Detailed information about the current pull request merge state status.

mergeable
MergeableState!

Whether or not the pull request can be merged based on the existence of merge conflicts.

merged
Boolean!

Whether or not the pull request was merged.

mergedAt
DateTime

The date and time that the pull request was merged.

mergedBy
Actor

The actor who merged the pull request.

milestone
Milestone

Identifies the milestone associated with the pull request.

number
Int!

Identifies the pull request number.

participants
UserConnection!

A list of Users that are participating in the Pull Request conversation.

Arguments

NameDescription
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.

permalink
URI!

The permalink to the pull request.

potentialMergeCommit
Commit

The commit that GitHub automatically generated to test if this pull request could be merged. This field will not return a value if the pull request is merged, or if the test merge commit is still being generated. See themergeable field for more details on the mergeability of the pull request.

projectCards
ProjectCardConnection!

List of project cards associated with this pull request.

Arguments

NameDescription
after
String

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

archivedStates
[ProjectCardArchivedState]

A list of archived states to filter the cards 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.

last
Int

Returns the last n elements from the list.

publishedAt
DateTime

Identifies when the comment was published at.

reactionGroups
[ReactionGroup!]

A list of reactions grouped by content left on the subject.

reactions
ReactionConnection!

A list of Reactions left on the Issue.

Arguments

NameDescription
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.

content
ReactionContent

Allows filtering Reactions by emoji.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ReactionOrder

Allows specifying the order in which reactions are returned.

repository
Repository!

The repository associated with this node.

resourcePath
URI!

The HTTP path for this pull request.

revertResourcePath
URI!

The HTTP path for reverting this pull request.

revertUrl
URI!

The HTTP URL for reverting this pull request.

reviewDecision
PullRequestReviewDecision

The current status of this pull request with respect to code review.

reviewRequests
ReviewRequestConnection

A list of review requests associated with the pull request.

Arguments

NameDescription
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.

reviewThreads
PullRequestReviewThreadConnection!

The list of all review threads for this pull request.

Arguments

NameDescription
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.

reviews
PullRequestReviewConnection

A list of reviews associated with the pull request.

Arguments

NameDescription
after
String

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

author
String

Filter by author of the review.

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.

states
[PullRequestReviewState!]

A list of states to filter the reviews.

state
PullRequestState!

Identifies the state of the pull request.

suggestedReviewers
[SuggestedReviewer]!

A list of reviewer suggestions based on commit history and past review comments.

timeline
PullRequestTimelineConnection!
Deprecated: `timeline` will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

A list of events, comments, commits, etc. associated with the pull request.

Arguments

NameDescription
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.

since
DateTime

Allows filtering timeline events by a since timestamp.

timelineItems
PullRequestTimelineItemsConnection!

A list of events, comments, commits, etc. associated with the pull request.

Arguments

NameDescription
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.

itemTypes
[PullRequestTimelineItemsItemType!]

Filter timeline items by type.

last
Int

Returns the last n elements from the list.

since
DateTime

Filter timeline items by a since timestamp.

skip
Int

Skips the first n elements in the list.

title
String!

Identifies the pull request title.

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this pull request.

userContentEdits
UserContentEditConnection

A list of edits to this content.

Arguments

NameDescription
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.

viewerCanApplySuggestion
Boolean!

Whether or not the viewer can apply suggestion.

viewerCanDeleteHeadRef
Boolean!

Check if the viewer can restore the deleted head ref.

viewerCanDisableAutoMerge
Boolean!

Whether or not the viewer can disable auto-merge

viewerCanEnableAutoMerge
Boolean!

Whether or not the viewer can enable auto-merge

viewerCanReact
Boolean!

Can user react to this subject

viewerCanSubscribe
Boolean!

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

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

viewerCannotUpdateReasons
[CommentCannotUpdateReason!]!

Reasons why the current viewer can not update this comment.

viewerDidAuthor
Boolean!

Did the viewer author this comment.

viewerLatestReview
PullRequestReview

The latest review given from the viewer.

viewerLatestReviewRequest
ReviewRequest

The person who has requested the viewer for review on this pull request.

viewerMergeBodyText
String!

The merge body text for the viewer and method.

Arguments

NameDescription
mergeType
PullRequestMergeMethod

The merge method for the message.

viewerMergeHeadlineText
String!

The merge headline text for the viewer and method.

Arguments

NameDescription
mergeType
PullRequestMergeMethod

The merge method for the message.

viewerSubscription
SubscriptionState

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

PullRequestChangedFile#

A file changed in a pull request.

Fields

NameDescription
additions
Int!

The number of additions to the file.

deletions
Int!

The number of deletions to the file.

path
String!

The path of the file.

viewerViewedState
FileViewedState!

The state of the file for the viewer.

PullRequestChangedFileConnection#

The connection type for PullRequestChangedFile.

Fields

NameDescription
edges
[PullRequestChangedFileEdge]

A list of edges.

nodes
[PullRequestChangedFile]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PullRequestChangedFileEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PullRequestChangedFile

The item at the end of the edge.

PullRequestCommit#

Represents a Git commit part of a pull request.

Implements

Fields

NameDescription
commit
Commit!

The Git commit object

id
ID!
pullRequest
PullRequest!

The pull request this commit belongs to

resourcePath
URI!

The HTTP path for this pull request commit

url
URI!

The HTTP URL for this pull request commit

PullRequestCommitCommentThread#

Represents a commit comment thread part of a pull request.

Implements

Fields

NameDescription
comments
CommitCommentConnection!

The comments that exist in this thread.

Arguments

NameDescription
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 the comments were made on.

id
ID!
path
String

The file the comments were made on.

position
Int

The position in the diff for the commit that the comment was made on.

pullRequest
PullRequest!

The pull request this commit comment thread belongs to

repository
Repository!

The repository associated with this node.

PullRequestCommitConnection#

The connection type for PullRequestCommit.

Fields

NameDescription
edges
[PullRequestCommitEdge]

A list of edges.

nodes
[PullRequestCommit]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PullRequestCommitEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PullRequestCommit

The item at the end of the edge.

PullRequestConnection#

The connection type for PullRequest.

Fields

NameDescription
edges
[PullRequestEdge]

A list of edges.

nodes
[PullRequest]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PullRequestContributionsByRepository#

This aggregates pull requests opened by a user within one repository.

Fields

NameDescription
contributions
CreatedPullRequestContributionConnection!

The pull request contributions.

Arguments

NameDescription
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
ContributionOrder

Ordering options for contributions returned from the connection.

repository
Repository!

The repository in which the pull requests were opened.

PullRequestEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PullRequest

The item at the end of the edge.

PullRequestReview#

A review object for a given pull request.

Implements

Fields

NameDescription
author
Actor

The actor who authored the comment.

authorAssociation
CommentAuthorAssociation!

Author's association with the subject of the comment.

authorCanPushToRepository
Boolean!

Indicates whether the author of this review has push access to the repository.

body
String!

Identifies the pull request review body.

bodyHTML
HTML!

The body rendered to HTML.

bodyText
String!

The body of this review rendered as plain text.

comments
PullRequestReviewCommentConnection!

A list of review comments for the current pull request review.

Arguments

NameDescription
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

Identifies the commit associated with this pull request review.

createdAt
DateTime!

Identifies the date and time when the object was created.

createdViaEmail
Boolean!

Check if this comment was created via an email reply.

databaseId
Int

Identifies the primary key from the database.

editor
Actor

The actor who edited the comment.

id
ID!
includesCreatedEdit
Boolean!

Check if this comment was edited and includes an edit with the creation data

lastEditedAt
DateTime

The moment the editor made the last edit

onBehalfOf
TeamConnection!

A list of teams that this review was made on behalf of.

Arguments

NameDescription
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.

publishedAt
DateTime

Identifies when the comment was published at.

pullRequest
PullRequest!

Identifies the pull request associated with this pull request review.

reactionGroups
[ReactionGroup!]

A list of reactions grouped by content left on the subject.

reactions
ReactionConnection!

A list of Reactions left on the Issue.

Arguments

NameDescription
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.

content
ReactionContent

Allows filtering Reactions by emoji.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ReactionOrder

Allows specifying the order in which reactions are returned.

repository
Repository!

The repository associated with this node.

resourcePath
URI!

The HTTP path permalink for this PullRequestReview.

state
PullRequestReviewState!

Identifies the current state of the pull request review.

submittedAt
DateTime

Identifies when the Pull Request Review was submitted

updatedAt
DateTime!

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

url
URI!

The HTTP URL permalink for this PullRequestReview.

userContentEdits
UserContentEditConnection

A list of edits to this content.

Arguments

NameDescription
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.

viewerCanDelete
Boolean!

Check if the current viewer can delete this object.

viewerCanReact
Boolean!

Can user react to this subject

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

viewerCannotUpdateReasons
[CommentCannotUpdateReason!]!

Reasons why the current viewer can not update this comment.

viewerDidAuthor
Boolean!

Did the viewer author this comment.

PullRequestReviewComment#

A review comment associated with a given repository pull request.

Implements

Fields

NameDescription
author
Actor

The actor who authored the comment.

authorAssociation
CommentAuthorAssociation!

Author's association with the subject of the comment.

body
String!

The comment body of this review comment.

bodyHTML
HTML!

The body rendered to HTML.

bodyText
String!

The comment body of this review comment rendered as plain text.

commit
Commit

Identifies the commit associated with the comment.

createdAt
DateTime!

Identifies when the comment was created.

createdViaEmail
Boolean!

Check if this comment was created via an email reply.

databaseId
Int

Identifies the primary key from the database.

diffHunk
String!

The diff hunk to which the comment applies.

draftedAt
DateTime!

Identifies when the comment was created in a draft state.

editor
Actor

The actor who edited the comment.

id
ID!
includesCreatedEdit
Boolean!

Check if this comment was edited and includes an edit with the creation data

isMinimized
Boolean!

Returns whether or not a comment has been minimized.

lastEditedAt
DateTime

The moment the editor made the last edit

minimizedReason
String

Returns why the comment was minimized.

originalCommit
Commit

Identifies the original commit associated with the comment.

originalPosition
Int!

The original line index in the diff to which the comment applies.

outdated
Boolean!

Identifies when the comment body is outdated

path
String!

The path to which the comment applies.

position
Int

The line index in the diff to which the comment applies.

publishedAt
DateTime

Identifies when the comment was published at.

pullRequest
PullRequest!

The pull request associated with this review comment.

pullRequestReview
PullRequestReview

The pull request review associated with this review comment.

reactionGroups
[ReactionGroup!]

A list of reactions grouped by content left on the subject.

reactions
ReactionConnection!

A list of Reactions left on the Issue.

Arguments

NameDescription
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.

content
ReactionContent

Allows filtering Reactions by emoji.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ReactionOrder

Allows specifying the order in which reactions are returned.

replyTo
PullRequestReviewComment

The comment this is a reply to.

repository
Repository!

The repository associated with this node.

resourcePath
URI!

The HTTP path permalink for this review comment.

state
PullRequestReviewCommentState!

Identifies the state of the comment.

updatedAt
DateTime!

Identifies when the comment was last updated.

url
URI!

The HTTP URL permalink for this review comment.

userContentEdits
UserContentEditConnection

A list of edits to this content.

Arguments

NameDescription
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.

viewerCanDelete
Boolean!

Check if the current viewer can delete this object.

viewerCanMinimize
Boolean!

Check if the current viewer can minimize this object.

viewerCanReact
Boolean!

Can user react to this subject

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

viewerCannotUpdateReasons
[CommentCannotUpdateReason!]!

Reasons why the current viewer can not update this comment.

viewerDidAuthor
Boolean!

Did the viewer author this comment.

PullRequestReviewCommentConnection#

The connection type for PullRequestReviewComment.

Fields

NameDescription
edges
[PullRequestReviewCommentEdge]

A list of edges.

nodes
[PullRequestReviewComment]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PullRequestReviewCommentEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PullRequestReviewComment

The item at the end of the edge.

PullRequestReviewConnection#

The connection type for PullRequestReview.

Fields

NameDescription
edges
[PullRequestReviewEdge]

A list of edges.

nodes
[PullRequestReview]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PullRequestReviewContributionsByRepository#

This aggregates pull request reviews made by a user within one repository.

Fields

NameDescription
contributions
CreatedPullRequestReviewContributionConnection!

The pull request review contributions.

Arguments

NameDescription
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
ContributionOrder

Ordering options for contributions returned from the connection.

repository
Repository!

The repository in which the pull request reviews were made.

PullRequestReviewEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PullRequestReview

The item at the end of the edge.

PullRequestReviewThread#

A threaded list of comments for a given pull request.

Implements

Fields

NameDescription
comments
PullRequestReviewCommentConnection!

A list of pull request comments associated with the thread.

Arguments

NameDescription
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.

skip
Int

Skips the first n elements in the list.

diffSide
DiffSide!

The side of the diff on which this thread was placed.

id
ID!
isCollapsed
Boolean!

Whether or not the thread has been collapsed (outdated or resolved)

isOutdated
Boolean!

Indicates whether this thread was outdated by newer changes.

isResolved
Boolean!

Whether this thread has been resolved

line
Int

The line in the file to which this thread refers

originalLine
Int

The original line in the file to which this thread refers.

originalStartLine
Int

The original start line in the file to which this thread refers (multi-line only).

path
String!

Identifies the file path of this thread.

pullRequest
PullRequest!

Identifies the pull request associated with this thread.

repository
Repository!

Identifies the repository associated with this thread.

resolvedBy
User

The user who resolved this thread

startDiffSide
DiffSide

The side of the diff that the first line of the thread starts on (multi-line only)

startLine
Int

The start line in the file to which this thread refers (multi-line only)

viewerCanReply
Boolean!

Indicates whether the current viewer can reply to this thread.

viewerCanResolve
Boolean!

Whether or not the viewer can resolve this thread

viewerCanUnresolve
Boolean!

Whether or not the viewer can unresolve this thread

PullRequestReviewThreadConnection#

Review comment threads for a pull request review.

Fields

NameDescription
edges
[PullRequestReviewThreadEdge]

A list of edges.

nodes
[PullRequestReviewThread]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PullRequestReviewThreadEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PullRequestReviewThread

The item at the end of the edge.

PullRequestRevisionMarker#

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

lastSeenCommit
Commit!

The last commit the viewer has seen.

pullRequest
PullRequest!

The pull request to which the marker belongs.

PullRequestTimelineConnection#

The connection type for PullRequestTimelineItem.

Fields

NameDescription
edges
[PullRequestTimelineItemEdge]

A list of edges.

nodes
[PullRequestTimelineItem]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PullRequestTimelineItemEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PullRequestTimelineItem

The item at the end of the edge.

PullRequestTimelineItemsConnection#

The connection type for PullRequestTimelineItems.

Fields

NameDescription
edges
[PullRequestTimelineItemsEdge]

A list of edges.

filteredCount
Int!

Identifies the count of items after applying before and after filters.

nodes
[PullRequestTimelineItems]

A list of nodes.

pageCount
Int!

Identifies the count of items after applying before/after filters and first/last/skip slicing.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

updatedAt
DateTime!

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

PullRequestTimelineItemsEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PullRequestTimelineItems

The item at the end of the edge.

Push#

A Git push.

Implements

Fields

NameDescription
id
ID!
nextSha
GitObjectID

The SHA after the push

permalink
URI!

The permalink for this push.

previousSha
GitObjectID

The SHA before the push

pusher
User!

The user who pushed

repository
Repository!

The repository that was pushed to

PushAllowance#

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

Implements

Fields

NameDescription
actor
PushAllowanceActor

The actor that can push.

branchProtectionRule
BranchProtectionRule

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

id
ID!

PushAllowanceConnection#

The connection type for PushAllowance.

Fields

NameDescription
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.

PushAllowanceEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
PushAllowance

The item at the end of the edge.

RateLimit#

Represents the client's rate limit.

Fields

NameDescription
cost
Int!

The point cost for the current query counting against the rate limit.

limit
Int!

The maximum number of points the client is permitted to consume in a 60 minute window.

nodeCount
Int!

The maximum number of nodes this query may return

remaining
Int!

The number of points remaining in the current rate limit window.

resetAt
DateTime!

The time at which the current rate limit window resets in UTC epoch seconds.

used
Int!

The number of points used in the current rate limit window.

ReactingUserConnection#

The connection type for User.

Fields

NameDescription
edges
[ReactingUserEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ReactingUserEdge#

Represents a user that's made a reaction.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
User!
reactedAt
DateTime!

The moment when the user made the reaction.

Reaction#

An emoji reaction to a particular piece of content.

Implements

Fields

NameDescription
content
ReactionContent!

Identifies the emoji reaction.

createdAt
DateTime!

Identifies the date and time when the object was created.

databaseId
Int

Identifies the primary key from the database.

id
ID!
reactable
Reactable!

The reactable piece of content

user
User

Identifies the user who created this reaction.

ReactionConnection#

A list of reactions that have been left on the subject.

Fields

NameDescription
edges
[ReactionEdge]

A list of edges.

nodes
[Reaction]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

viewerHasReacted
Boolean!

Whether or not the authenticated user has left a reaction on the subject.

ReactionEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Reaction

The item at the end of the edge.

ReactionGroup#

A group of emoji reactions to a particular piece of content.

Fields

NameDescription
content
ReactionContent!

Identifies the emoji reaction.

createdAt
DateTime

Identifies when the reaction was created.

subject
Reactable!

The subject that was reacted to.

users
ReactingUserConnection!

Users who have reacted to the reaction subject with the emotion represented by this reaction group

Arguments

NameDescription
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.

viewerHasReacted
Boolean!

Whether or not the authenticated user has left a reaction on the subject.

ReadyForReviewEvent#

Represents a 'ready_for_review' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

resourcePath
URI!

The HTTP path for this ready for review event.

url
URI!

The HTTP URL for this ready for review event.

Ref#

Represents a Git reference.

Implements

Fields

NameDescription
associatedPullRequests
PullRequestConnection!

A list of pull requests with this ref as the head ref.

Arguments

NameDescription
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.

states
[PullRequestState!]

A list of states to filter the pull requests by.

branchProtectionRule
BranchProtectionRule

Branch protection rules for this ref

id
ID!
name
String!

The ref name.

prefix
String!

The ref's prefix, such as refs/heads/ or refs/tags/.

refUpdateRule
RefUpdateRule

Branch protection rules that are viewable by non-admins

repository
Repository!

The repository the ref belongs to.

target
GitObject

The object the ref points to. Returns null when object does not exist.

RefConnection#

The connection type for Ref.

Fields

NameDescription
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.

RefEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Ref

The item at the end of the edge.

ReferencedEvent#

Represents a 'referenced' event on a given ReferencedSubject.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

commit
Commit

Identifies the commit associated with the 'referenced' event.

commitRepository
Repository!

Identifies the repository associated with the 'referenced' event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
isCrossRepository
Boolean!

Reference originated in a different repository.

isDirectReference
Boolean!

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

subject
ReferencedSubject!

Object referenced by event.

RefUpdateRule#

A ref update rules for a viewer.

Fields

NameDescription
allowsDeletions
Boolean!

Can this branch be deleted.

allowsForcePushes
Boolean!

Are force pushes allowed on this branch.

pattern
String!

Identifies the protection rule pattern.

requiredApprovingReviewCount
Int

Number of approving reviews required to update matching branches.

requiredStatusCheckContexts
[String]

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

requiresCodeOwnerReviews
Boolean!

Are reviews from code owners required to update matching branches.

requiresLinearHistory
Boolean!

Are merge commits prohibited from being pushed to this branch.

requiresSignatures
Boolean!

Are commits required to be signed.

viewerAllowedToDismissReviews
Boolean!

Is the viewer allowed to dismiss reviews.

viewerCanPush
Boolean!

Can the viewer push to the branch

RegenerateEnterpriseIdentityProviderRecoveryCodesPayload#

Autogenerated return type of RegenerateEnterpriseIdentityProviderRecoveryCodes

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

identityProvider
EnterpriseIdentityProvider

The identity provider for the enterprise.

RegenerateVerifiableDomainTokenPayload#

Autogenerated return type of RegenerateVerifiableDomainToken

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

verificationToken
String

The verification token that was generated.

Release#

A release contains the content for a release.

Implements

Fields

NameDescription
author
User

The author of the release

createdAt
DateTime!

Identifies the date and time when the object was created.

description
String

The description of the release.

descriptionHTML
HTML

The description of this release rendered to HTML.

id
ID!
isDraft
Boolean!

Whether or not the release is a draft

isLatest
Boolean!

Whether or not the release is the latest releast

isPrerelease
Boolean!

Whether or not the release is a prerelease

name
String

The title of the release.

publishedAt
DateTime

Identifies the date and time when the release was created.

releaseAssets
ReleaseAssetConnection!

List of releases assets which are dependent on this release.

Arguments

NameDescription
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.

name
String

A list of names to filter the assets by.

repository
Repository!

The repository that the release belongs to.

resourcePath
URI!

The HTTP path for this issue

shortDescriptionHTML
HTML

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

Arguments

NameDescription
limit
Int

How many characters to return.

tag
Ref

The Git tag the release points to

tagCommit
Commit

The tag commit for this release.

tagName
String!

The name of the release's Git tag

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this issue

ReleaseAsset#

A release asset contains the content for a release asset.

Implements

Fields

NameDescription
contentType
String!

The asset's content-type

createdAt
DateTime!

Identifies the date and time when the object was created.

downloadCount
Int!

The number of times this asset was downloaded

downloadUrl
URI!

Identifies the URL where you can download the release asset via the browser.

id
ID!
name
String!

Identifies the title of the release asset.

release
Release

Release that the asset is associated with

size
Int!

The size (in bytes) of the asset

updatedAt
DateTime!

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

uploadedBy
User!

The user that performed the upload

url
URI!

Identifies the URL of the release asset.

ReleaseAssetConnection#

The connection type for ReleaseAsset.

Fields

NameDescription
edges
[ReleaseAssetEdge]

A list of edges.

nodes
[ReleaseAsset]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ReleaseAssetEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
ReleaseAsset

The item at the end of the edge.

ReleaseConnection#

The connection type for Release.

Fields

NameDescription
edges
[ReleaseEdge]

A list of edges.

nodes
[Release]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ReleaseEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Release

The item at the end of the edge.

RemoveAssigneesFromAssignablePayload#

Autogenerated return type of RemoveAssigneesFromAssignable

Fields

NameDescription
assignable
Assignable

The item that was unassigned.

clientMutationId
String

A unique identifier for the client performing the mutation.

RemovedFromProjectEvent#

Represents a 'removed_from_project' event on a given issue or pull request.

Implements

Fields

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.

id
ID!
project
Project

Project referenced by event.

projectColumnName
String!

Column name referenced by this project event.

RemoveEnterpriseAdminPayload#

Autogenerated return type of RemoveEnterpriseAdmin

Fields

NameDescription
admin
User

The user who was removed as an administrator.

clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The updated enterprise.

message
String

A message confirming the result of removing an administrator.

viewer
User

The viewer performing the mutation.

RemoveEnterpriseIdentityProviderPayload#

Autogenerated return type of RemoveEnterpriseIdentityProvider

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

identityProvider
EnterpriseIdentityProvider

The identity provider that was removed from the enterprise.

RemoveEnterpriseOrganizationPayload#

Autogenerated return type of RemoveEnterpriseOrganization

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The updated enterprise.

organization
Organization

The organization that was removed from the enterprise.

viewer
User

The viewer performing the mutation.

RemoveEnterpriseSupportEntitlementPayload#

Autogenerated return type of RemoveEnterpriseSupportEntitlement

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

message
String

A message confirming the result of removing the support entitlement.

RemoveLabelsFromLabelablePayload#

Autogenerated return type of RemoveLabelsFromLabelable

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

labelable
Labelable

The Labelable the labels were removed from.

RemoveOutsideCollaboratorPayload#

Autogenerated return type of RemoveOutsideCollaborator

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

removedUser
User

The user that was removed as an outside collaborator.

RemoveReactionPayload#

Autogenerated return type of RemoveReaction

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

reaction
Reaction

The reaction object.

subject
Reactable

The reactable subject.

RemoveStarPayload#

Autogenerated return type of RemoveStar

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

starrable
Starrable

The starrable.

RenamedTitleEvent#

Represents a 'renamed' event on a given issue or pull request

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

currentTitle
String!

Identifies the current title of the issue or pull request.

id
ID!
previousTitle
String!

Identifies the previous title of the issue or pull request.

subject
RenamedTitleSubject!

Subject that was renamed.

ReopenedEvent#

Represents a 'reopened' event on any Closable.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

closable
Closable!

Object that was reopened.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!

ReopenIssuePayload#

Autogenerated return type of ReopenIssue

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issue
Issue

The issue that was opened.

ReopenPullRequestPayload#

Autogenerated return type of ReopenPullRequest

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The pull request that was reopened.

RepoAccessAuditEntry#

Audit log entry for a repo.access event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

visibility
RepoAccessAuditEntryVisibility

The visibility of the repository

RepoAddMemberAuditEntry#

Audit log entry for a repo.add_member event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

visibility
RepoAddMemberAuditEntryVisibility

The visibility of the repository

RepoAddTopicAuditEntry#

Audit log entry for a repo.add_topic event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

topic
Topic

The name of the topic added to the repository

topicName
String

The name of the topic added to the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoArchivedAuditEntry#

Audit log entry for a repo.archived event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

visibility
RepoArchivedAuditEntryVisibility

The visibility of the repository

RepoChangeMergeSettingAuditEntry#

Audit log entry for a repo.change_merge_setting event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
isEnabled
Boolean

Whether the change was to enable (true) or disable (false) the merge type

mergeType
RepoChangeMergeSettingAuditEntryMergeType

The merge method affected by the change

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigDisableAnonymousGitAccessAuditEntry#

Audit log entry for a repo.config.disable_anonymous_git_access event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigDisableCollaboratorsOnlyAuditEntry#

Audit log entry for a repo.config.disable_collaborators_only event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigDisableContributorsOnlyAuditEntry#

Audit log entry for a repo.config.disable_contributors_only event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigDisableSockpuppetDisallowedAuditEntry#

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigEnableAnonymousGitAccessAuditEntry#

Audit log entry for a repo.config.enable_anonymous_git_access event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigEnableCollaboratorsOnlyAuditEntry#

Audit log entry for a repo.config.enable_collaborators_only event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigEnableContributorsOnlyAuditEntry#

Audit log entry for a repo.config.enable_contributors_only event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigEnableSockpuppetDisallowedAuditEntry#

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigLockAnonymousGitAccessAuditEntry#

Audit log entry for a repo.config.lock_anonymous_git_access event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoConfigUnlockAnonymousGitAccessAuditEntry#

Audit log entry for a repo.config.unlock_anonymous_git_access event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepoCreateAuditEntry#

Audit log entry for a repo.create event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

forkParentName
String

The name of the parent repository for this forked repository.

forkSourceName
String

The name of the root repository for this network.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

visibility
RepoCreateAuditEntryVisibility

The visibility of the repository

RepoDestroyAuditEntry#

Audit log entry for a repo.destroy event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

visibility
RepoDestroyAuditEntryVisibility

The visibility of the repository

RepoRemoveMemberAuditEntry#

Audit log entry for a repo.remove_member event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

visibility
RepoRemoveMemberAuditEntryVisibility

The visibility of the repository

RepoRemoveTopicAuditEntry#

Audit log entry for a repo.remove_topic event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

topic
Topic

The name of the topic added to the repository

topicName
String

The name of the topic added to the repository

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

Repository#

A repository contains the content for a project.

Implements

Fields

NameDescription
assignableUsers
UserConnection!

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

Arguments

NameDescription
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 users with query on user name and login

branchProtectionRules
BranchProtectionRuleConnection!

A list of branch protection rules for this repository.

Arguments

NameDescription
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.

codeOfConduct
CodeOfConduct

Returns the code of conduct for this repository

collaborators
RepositoryCollaboratorConnection

A list of collaborators associated with the repository.

Arguments

NameDescription
affiliation
CollaboratorAffiliation

Collaborators affiliation level with a repository.

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 users with query on user name and login

commitComments
CommitCommentConnection!

A list of commit comments associated with the repository.

Arguments

NameDescription
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.

contactLinks
[RepositoryContactLink!]

Returns a list of contact links associated to the 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

Arguments

NameDescription
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.

dependenciesAfter
String

Cursor to paginate dependencies

dependenciesFirst
Int

Number of dependencies to fetch

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

withDependencies
Boolean

Flag to scope to only manifests with dependencies

deployKeys
DeployKeyConnection!

A list of deploy keys that are on this repository.

Arguments

NameDescription
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.

deployments
DeploymentConnection!

Deployments associated with the repository

Arguments

NameDescription
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.

environments
[String!]

Environments to list deployments for

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
DeploymentOrder

Ordering options for deployments returned from the connection.

description
String

The description of the repository.

descriptionHTML
HTML!

The description of the repository rendered to HTML.

diskUsage
Int

The number of kilobytes this repository occupies on disk.

forkCount
Int!

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

forks
RepositoryConnection!

A list of direct forked repositories.

Arguments

NameDescription
affiliations
[RepositoryAffiliation]

Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.

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.

isLocked
Boolean

If non-null, filters repositories according to whether they have been locked

last
Int

Returns the last n elements from the list.

orderBy
RepositoryOrder

Ordering options for repositories returned from the connection

ownerAffiliations
[RepositoryAffiliation]

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

privacy
RepositoryPrivacy

If non-null, filters repositories according to privacy

fundingLinks
[FundingLink!]!

The funding links for this repository

hasIssuesEnabled
Boolean!

Indicates if the repository has issues feature enabled.

hasProjectsEnabled
Boolean!

Indicates if the repository has the Projects feature enabled.

hasWikiEnabled
Boolean!

Indicates if the repository has wiki feature enabled.

homepageUrl
URI

The repository's URL.

id
ID!
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.

Arguments

NameDescription
number
Int!

The number for the issue to be returned.

issueOrPullRequest
IssueOrPullRequest

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

Arguments

NameDescription
number
Int!

The number for the issue to be returned.

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.

Arguments

NameDescription
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.

filterBy
IssueFilters

Filtering options for issues returned from the connection.

first
Int

Returns the first n elements from the list.

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 issues returned from the connection.

states
[IssueState!]

A list of states to filter the issues by.

label
Label

Returns a single label by name

Arguments

NameDescription
name
String!

Label name

labels
LabelConnection

A list of labels associated with the repository.

Arguments

NameDescription
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
LabelOrder

Ordering options for labels returned from the connection.

query
String

If provided, searches labels by name and description.

languages
LanguageConnection

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

Arguments

NameDescription
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
LanguageOrder

Order for connection

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.

Arguments

NameDescription
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 users with query on user name and login

mergeCommitAllowed
Boolean!

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

milestone
Milestone

Returns a single milestone from the current repository by number.

Arguments

NameDescription
number
Int!

The number for the milestone to be returned.

milestones
MilestoneConnection

A list of milestones associated with the repository.

Arguments

NameDescription
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
MilestoneOrder

Ordering options for milestones.

query
String

Filters milestones with a query on the title

states
[MilestoneState!]

Filter by the state of the milestones.

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

Arguments

NameDescription
expression
String

A Git revision expression suitable for rev-parse

oid
GitObjectID

The Git object ID

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.

Arguments

NameDescription
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.

names
[String]

Find packages by their names.

orderBy
PackageOrder

Ordering of the returned packages.

packageType
PackageType

Filter registry package by type.

repositoryId
ID

Find packages in a repository by ID.

parent
Repository

The repository parent, if this is a fork.

pinnedIssues
PinnedIssueConnection

A list of pinned issues for this repository.

Arguments

NameDescription
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.

primaryLanguage
Language

The primary language of the repository's code.

project
Project

Find project by number.

Arguments

NameDescription
number
Int!

The project number to find.

projects
ProjectConnection!

A list of projects under the owner.

Arguments

NameDescription
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
ProjectOrder

Ordering options for projects returned from the connection

search
String

Query to search projects by, currently only searching by name.

states
[ProjectState!]

A list of states to filter the projects by.

projectsResourcePath
URI!

The HTTP path listing the repository's projects

projectsUrl
URI!

The HTTP URL listing the repository's projects

pullRequest
PullRequest

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

Arguments

NameDescription
number
Int!

The number for the pull request to be returned.

pullRequests
PullRequestConnection!

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

Arguments

NameDescription
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.

states
[PullRequestState!]

A list of states to filter the pull requests by.

pushedAt
DateTime

Identifies when the repository was last pushed to.

rebaseMergeAllowed
Boolean!

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

ref
Ref

Fetch a given ref from the repository

Arguments

NameDescription
qualifiedName
String!

The ref to retrieve. Fully qualified matches are checked in order (refs/heads/master) before falling back onto checks for short name matches (master).

refs
RefConnection

Fetch a list of refs from the repository

Arguments

NameDescription
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.

direction
OrderDirection

DEPRECATED: use orderBy. The ordering direction.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
RefOrder

Ordering options for refs returned from the connection.

query
String

Filters refs with query on name

refPrefix
String!

A ref name prefix like refs/heads/, refs/tags/, etc.

release
Release

Lookup a single release given various criteria.

Arguments

NameDescription
tagName
String!

The name of the Tag the Release was created from

releases
ReleaseConnection!

List of releases which are dependent on this repository.

Arguments

NameDescription
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
ReleaseOrder

Order for connection

repositoryTopics
RepositoryTopicConnection!

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

Arguments

NameDescription
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.

resourcePath
URI!

The HTTP path for this repository

securityPolicyUrl
URI

The security policy URL.

shortDescriptionHTML
HTML!

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

Arguments

NameDescription
limit
Int

How many characters to return.

squashMergeAllowed
Boolean!

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

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.

Arguments

NameDescription
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
StarOrder

Order for connection

submodules
SubmoduleConnection!

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

Arguments

NameDescription
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.

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.

vulnerabilityAlerts
RepositoryVulnerabilityAlertConnection

A list of vulnerability alerts that are on this repository.

Arguments

NameDescription
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.

watchers
UserConnection!

A list of users watching the repository.

Arguments

NameDescription
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.

RepositoryCollaboratorConnection#

The connection type for User.

Fields

NameDescription
edges
[RepositoryCollaboratorEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

RepositoryCollaboratorEdge#

Represents a user who is a collaborator of a repository.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
User!
permission
RepositoryPermission!

The permission the user has on the repository.

permissionSources
[PermissionSource!]

A list of sources for the user's access to the repository.

RepositoryConnection#

A list of repositories owned by the subject.

Fields

NameDescription
edges
[RepositoryEdge]

A list of edges.

nodes
[Repository]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

totalDiskUsage
Int!

The total size in kilobytes of all repositories in the connection.

RepositoryContactLink#

A repository contact link.

Fields

NameDescription
about
String!

The contact link purpose.

name
String!

The contact link name.

url
URI!

The contact link URL.

RepositoryEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Repository

The item at the end of the edge.

RepositoryInteractionAbility#

Repository interaction limit that applies to this object.

Fields

NameDescription
expiresAt
DateTime

The time the currently active limit expires.

limit
RepositoryInteractionLimit!

The current limit that is enabled on this object.

origin
RepositoryInteractionLimitOrigin!

The origin of the currently active interaction limit.

RepositoryInvitation#

An invitation for a user to be added to a repository.

Implements

Fields

NameDescription
email
String

The email address that received the invitation.

id
ID!
invitee
User

The user who received the invitation.

inviter
User!

The user who created the invitation.

permalink
URI!

The permalink for this repository invitation.

permission
RepositoryPermission!

The permission granted on this repository by this invitation.

repository
RepositoryInfo

The Repository the user is invited to.

RepositoryInvitationConnection#

The connection type for RepositoryInvitation.

Fields

NameDescription
edges
[RepositoryInvitationEdge]

A list of edges.

nodes
[RepositoryInvitation]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

RepositoryInvitationEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
RepositoryInvitation

The item at the end of the edge.

RepositoryTopic#

A repository-topic connects a repository to a topic.

Implements

Fields

NameDescription
id
ID!
resourcePath
URI!

The HTTP path for this repository-topic.

topic
Topic!

The topic.

url
URI!

The HTTP URL for this repository-topic.

RepositoryTopicConnection#

The connection type for RepositoryTopic.

Fields

NameDescription
edges
[RepositoryTopicEdge]

A list of edges.

nodes
[RepositoryTopic]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

RepositoryTopicEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
RepositoryTopic

The item at the end of the edge.

RepositoryVisibilityChangeDisableAuditEntry#

Audit log entry for a repository_visibility_change.disable event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

enterpriseResourcePath
URI

The HTTP path for this enterprise.

enterpriseSlug
String

The slug of the enterprise.

enterpriseUrl
URI

The HTTP URL for this enterprise.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepositoryVisibilityChangeEnableAuditEntry#

Audit log entry for a repository_visibility_change.enable event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

enterpriseResourcePath
URI

The HTTP path for this enterprise.

enterpriseSlug
String

The slug of the enterprise.

enterpriseUrl
URI

The HTTP URL for this enterprise.

id
ID!
operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

RepositoryVulnerabilityAlert#

A alert for a repository with an affected vulnerability.

Implements

Fields

NameDescription
createdAt
DateTime!

When was the alert created?

dismissReason
String

The reason the alert was dismissed

dismissedAt
DateTime

When was the alert dismissed?

dismisser
User

The user who dismissed the alert

id
ID!
repository
Repository!

The associated repository

securityAdvisory
SecurityAdvisory

The associated security advisory

securityVulnerability
SecurityVulnerability

The associated security vulnerability

vulnerableManifestFilename
String!

The vulnerable manifest filename

vulnerableManifestPath
String!

The vulnerable manifest path

vulnerableRequirements
String

The vulnerable requirements

RepositoryVulnerabilityAlertConnection#

The connection type for RepositoryVulnerabilityAlert.

Fields

NameDescription
edges
[RepositoryVulnerabilityAlertEdge]

A list of edges.

nodes
[RepositoryVulnerabilityAlert]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

RepositoryVulnerabilityAlertEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
RepositoryVulnerabilityAlert

The item at the end of the edge.

RequestReviewsPayload#

Autogenerated return type of RequestReviews

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The pull request that is getting requests.

requestedReviewersEdge
UserEdge

The edge from the pull request to the requested reviewers.

RerequestCheckSuitePayload#

Autogenerated return type of RerequestCheckSuite

Fields

NameDescription
checkSuite
CheckSuite

The requested check suite.

clientMutationId
String

A unique identifier for the client performing the mutation.

ResolveReviewThreadPayload#

Autogenerated return type of ResolveReviewThread

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

thread
PullRequestReviewThread

The thread to resolve.

RestrictedContribution#

Represents a private contribution a user made on GitHub.

Implements

Fields

NameDescription
isRestricted
Boolean!

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt
DateTime!

When this contribution was made.

resourcePath
URI!

The HTTP path for this contribution.

url
URI!

The HTTP URL for this contribution.

user
User!

The user who made this contribution.

ReviewDismissalAllowance#

A team or user who has the ability to dismiss a review on a protected branch.

Implements

Fields

NameDescription
actor
ReviewDismissalAllowanceActor

The actor that can dismiss.

branchProtectionRule
BranchProtectionRule

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

id
ID!

ReviewDismissalAllowanceConnection#

The connection type for ReviewDismissalAllowance.

Fields

NameDescription
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.

ReviewDismissalAllowanceEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
ReviewDismissalAllowance

The item at the end of the edge.

ReviewDismissedEvent#

Represents a 'review_dismissed' event on a given issue or pull request.

Implements

Fields

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.

dismissalMessage
String

Identifies the optional message associated with the 'review_dismissed' event.

dismissalMessageHTML
String

Identifies the optional message associated with the event, rendered to HTML.

id
ID!
previousReviewState
PullRequestReviewState!

Identifies the previous state of the review with the 'review_dismissed' event.

pullRequest
PullRequest!

PullRequest referenced by event.

pullRequestCommit
PullRequestCommit

Identifies the commit which caused the review to become stale.

resourcePath
URI!

The HTTP path for this review dismissed event.

review
PullRequestReview

Identifies the review associated with the 'review_dismissed' event.

url
URI!

The HTTP URL for this review dismissed event.

ReviewRequest#

A request for a user to review a pull request.

Implements

Fields

NameDescription
asCodeOwner
Boolean!

Whether this request was created for a code owner

databaseId
Int

Identifies the primary key from the database.

id
ID!
pullRequest
PullRequest!

Identifies the pull request associated with this review request.

requestedReviewer
RequestedReviewer

The reviewer that is requested.

ReviewRequestConnection#

The connection type for ReviewRequest.

Fields

NameDescription
edges
[ReviewRequestEdge]

A list of edges.

nodes
[ReviewRequest]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ReviewRequestedEvent#

Represents an 'review_requested' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

requestedReviewer
RequestedReviewer

Identifies the reviewer whose review was requested.

ReviewRequestEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
ReviewRequest

The item at the end of the edge.

ReviewRequestRemovedEvent#

Represents an 'review_request_removed' event on a given pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
pullRequest
PullRequest!

PullRequest referenced by event.

requestedReviewer
RequestedReviewer

Identifies the reviewer whose review request was removed.

ReviewStatusHovercardContext#

A hovercard context with a message describing the current code review state of the pull request.

Implements

Fields

NameDescription
message
String!

A string describing this context

octicon
String!

An octicon to accompany this context

reviewDecision
PullRequestReviewDecision

The current status of the pull request with respect to code review.

SavedReply#

A Saved Reply is text a user can use to reply quickly.

Implements

Fields

NameDescription
body
String!

The body of the saved reply.

bodyHTML
HTML!

The saved reply body rendered to HTML.

databaseId
Int

Identifies the primary key from the database.

id
ID!
title
String!

The title of the saved reply.

user
Actor

The user that saved this reply.

SavedReplyConnection#

The connection type for SavedReply.

Fields

NameDescription
edges
[SavedReplyEdge]

A list of edges.

nodes
[SavedReply]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

SavedReplyEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
SavedReply

The item at the end of the edge.

SearchResultItemConnection#

A list of results that matched against a search query.

Fields

NameDescription
codeCount
Int!

The number of pieces of code that matched the search query.

edges
[SearchResultItemEdge]

A list of edges.

issueCount
Int!

The number of issues that matched the search query.

nodes
[SearchResultItem]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

repositoryCount
Int!

The number of repositories that matched the search query.

userCount
Int!

The number of users that matched the search query.

wikiCount
Int!

The number of wiki pages that matched the search query.

SearchResultItemEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
SearchResultItem

The item at the end of the edge.

textMatches
[TextMatch]

Text matches on the result found.

SecurityAdvisory#

A GitHub Security Advisory

Implements

Fields

NameDescription
cvss
CVSS!

The CVSS associated with this advisory

cwes
CWEConnection!

CWEs associated with this Advisory

Arguments

NameDescription
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.

databaseId
Int

Identifies the primary key from the database.

description
String!

This is a long plaintext description of the advisory

ghsaId
String!

The GitHub Security Advisory ID

id
ID!
identifiers
[SecurityAdvisoryIdentifier!]!

A list of identifiers for this advisory

notificationsPermalink
URI

The permalink for the advisory's dependabot alerts page

origin
String!

The organization that originated the advisory

permalink
URI

The permalink for the advisory

publishedAt
DateTime!

When the advisory was published

references
[SecurityAdvisoryReference!]!

A list of references for this advisory

severity
SecurityAdvisorySeverity!

The severity of the advisory

summary
String!

A short plaintext summary of the advisory

updatedAt
DateTime!

When the advisory was last updated

vulnerabilities
SecurityVulnerabilityConnection!

Vulnerabilities associated with this Advisory

Arguments

NameDescription
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.

ecosystem
SecurityAdvisoryEcosystem

An ecosystem to filter vulnerabilities by.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
SecurityVulnerabilityOrder

Ordering options for the returned topics.

package
String

A package name to filter vulnerabilities by.

severities
[SecurityAdvisorySeverity!]

A list of severities to filter vulnerabilities by.

withdrawnAt
DateTime

When the advisory was withdrawn, if it has been withdrawn

SecurityAdvisoryConnection#

The connection type for SecurityAdvisory.

Fields

NameDescription
edges
[SecurityAdvisoryEdge]

A list of edges.

nodes
[SecurityAdvisory]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

SecurityAdvisoryEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
SecurityAdvisory

The item at the end of the edge.

SecurityAdvisoryIdentifier#

A GitHub Security Advisory Identifier

Fields

NameDescription
type
String!

The identifier type, e.g. GHSA, CVE

value
String!

The identifier

SecurityAdvisoryPackage#

An individual package

Fields

NameDescription
ecosystem
SecurityAdvisoryEcosystem!

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM

name
String!

The package name

SecurityAdvisoryPackageVersion#

An individual package version

Fields

NameDescription
identifier
String!

The package name or version

SecurityAdvisoryReference#

A GitHub Security Advisory Reference

Fields

NameDescription
url
URI!

A publicly accessible reference

SecurityVulnerability#

An individual vulnerability within an Advisory

Fields

NameDescription
advisory
SecurityAdvisory!

The Advisory associated with this Vulnerability

firstPatchedVersion
SecurityAdvisoryPackageVersion

The first version containing a fix for the vulnerability

package
SecurityAdvisoryPackage!

A description of the vulnerable package

severity
SecurityAdvisorySeverity!

The severity of the vulnerability within this package

updatedAt
DateTime!

When the vulnerability was last updated

vulnerableVersionRange
String!

A string that describes the vulnerable package versions. This string follows a basic syntax with a few forms.

  • = 0.2.0 denotes a single vulnerable version.
  • <= 1.0.8 denotes a version range up to and including the specified version
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum

SecurityVulnerabilityConnection#

The connection type for SecurityVulnerability.

Fields

NameDescription
edges
[SecurityVulnerabilityEdge]

A list of edges.

nodes
[SecurityVulnerability]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

SecurityVulnerabilityEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
SecurityVulnerability

The item at the end of the edge.

SetEnterpriseIdentityProviderPayload#

Autogenerated return type of SetEnterpriseIdentityProvider

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

identityProvider
EnterpriseIdentityProvider

The identity provider for the enterprise.

SetOrganizationInteractionLimitPayload#

Autogenerated return type of SetOrganizationInteractionLimit

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

organization
Organization

The organization that the interaction limit was set for.

SetRepositoryInteractionLimitPayload#

Autogenerated return type of SetRepositoryInteractionLimit

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repository
Repository

The repository that the interaction limit was set for.

SetUserInteractionLimitPayload#

Autogenerated return type of SetUserInteractionLimit

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

user
User

The user that the interaction limit was set for.

SmimeSignature#

Represents an S/MIME signature on a Commit or Tag.

Implements

Fields

NameDescription
email
String!

Email used to sign this object.

isValid
Boolean!

True if the signature is valid and verified by GitHub.

payload
String!

Payload for GPG signing object. Raw ODB object without the signature header.

signature
String!

ASCII-armored signature header from object.

signer
User

GitHub user corresponding to the email signing this commit.

state
GitSignatureState!

The state of this signature. VALID if signature is valid and verified by GitHub, otherwise represents reason why signature is considered invalid.

wasSignedByGitHub
Boolean!

True if the signature was made with GitHub's signing key.

SponsorableItemConnection#

The connection type for SponsorableItem.

Fields

NameDescription
edges
[SponsorableItemEdge]

A list of edges.

nodes
[SponsorableItem]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

SponsorableItemEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
SponsorableItem

The item at the end of the edge.

SponsorsGoal#

A goal associated with a GitHub Sponsors listing, representing a target the sponsored maintainer would like to attain.

Fields

NameDescription
description
String

A description of the goal from the maintainer.

kind
SponsorsGoalKind!

What the objective of this goal is.

percentComplete
Int!

The percentage representing how complete this goal is, between 0-100.

targetValue
Int!

What the goal amount is. Represents a dollar amount for monthly sponsorship amount goals. Represents a count of unique sponsors for total sponsors count goals.

title
String!

A brief summary of the kind and target value of this goal.

Sponsorship#

A sponsorship relationship between a sponsor and a maintainer

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
isOneTimePayment
Boolean!

Whether this sponsorship represents a one-time payment versus a recurring sponsorship.

maintainer
User!
Deprecated: `Sponsorship.maintainer` will be removed. Use `Sponsorship.sponsorable` instead. Removal on 2020-04-01 UTC.

The entity that is being sponsored

privacyLevel
SponsorshipPrivacy!

The privacy level for this sponsorship.

sponsor
User
Deprecated: `Sponsorship.sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead. Removal on 2020-10-01 UTC.

The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

sponsorEntity
Sponsor

The user or organization that is sponsoring, if you have permission to view them.

sponsorable
Sponsorable!

The entity that is being sponsored

tier
SponsorsTier

The associated sponsorship tier

tierSelectedAt
DateTime

Identifies the date and time when the current tier was chosen for this sponsorship.

SponsorshipConnection#

The connection type for Sponsorship.

Fields

NameDescription
edges
[SponsorshipEdge]

A list of edges.

nodes
[Sponsorship]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

SponsorshipEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Sponsorship

The item at the end of the edge.

SponsorsListing#

A GitHub Sponsors listing.

Implements

Fields

NameDescription
activeGoal
SponsorsGoal

The current goal the maintainer is trying to reach with GitHub Sponsors, if any.

createdAt
DateTime!

Identifies the date and time when the object was created.

fullDescription
String!

The full description of the listing.

fullDescriptionHTML
HTML!

The full description of the listing rendered to HTML.

id
ID!
name
String!

The listing's full name.

shortDescription
String!

The short description of the listing.

slug
String!

The short name of the listing.

tiers
SponsorsTierConnection

The published tiers for this GitHub Sponsors listing.

Arguments

NameDescription
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
SponsorsTierOrder

Ordering options for Sponsors tiers returned from the connection.

SponsorsTier#

A GitHub Sponsors tier associated with a GitHub Sponsors listing.

Implements

Fields

NameDescription
adminInfo
SponsorsTierAdminInfo

SponsorsTier information only visible to users that can administer the associated Sponsors listing.

closestLesserValueTier
SponsorsTier

Get a different tier for this tier's maintainer that is at the same frequency as this tier but with a lesser cost. Returns the published tier with the monthly price closest to this tier's without going over.

createdAt
DateTime!

Identifies the date and time when the object was created.

description
String!

The description of the tier.

descriptionHTML
HTML!

The tier description rendered to HTML

id
ID!
isCustomAmount
Boolean!

Whether this tier was chosen at checkout time by the sponsor rather than defined ahead of time by the maintainer who manages the Sponsors listing.

isOneTime
Boolean!

Whether this tier is only for use with one-time sponsorships.

monthlyPriceInCents
Int!

How much this tier costs per month in cents.

monthlyPriceInDollars
Int!

How much this tier costs per month in dollars.

name
String!

The name of the tier.

sponsorsListing
SponsorsListing!

The sponsors listing that this tier belongs to.

updatedAt
DateTime!

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

SponsorsTierAdminInfo#

SponsorsTier information only visible to users that can administer the associated Sponsors listing.

Fields

NameDescription
sponsorships
SponsorshipConnection!

The sponsorships associated with this tier.

Arguments

NameDescription
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.

includePrivate
Boolean

Whether or not to include private sponsorships in the result set

last
Int

Returns the last n elements from the list.

orderBy
SponsorshipOrder

Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.

SponsorsTierConnection#

The connection type for SponsorsTier.

Fields

NameDescription
edges
[SponsorsTierEdge]

A list of edges.

nodes
[SponsorsTier]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

SponsorsTierEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
SponsorsTier

The item at the end of the edge.

StargazerConnection#

The connection type for User.

Fields

NameDescription
edges
[StargazerEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

StargazerEdge#

Represents a user that's starred a repository.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
User!
starredAt
DateTime!

Identifies when the item was starred.

StarredRepositoryConnection#

The connection type for Repository.

Fields

NameDescription
edges
[StarredRepositoryEdge]

A list of edges.

isOverLimit
Boolean!

Is the list of stars for this user truncated? This is true for users that have many stars.

nodes
[Repository]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

StarredRepositoryEdge#

Represents a starred repository.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Repository!
starredAt
DateTime!

Identifies when the item was starred.

Status#

Represents a commit status.

Implements

Fields

NameDescription
combinedContexts
StatusCheckRollupContextConnection!

A list of status contexts and check runs for this commit.

Arguments

NameDescription
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 this status is attached to.

context
StatusContext

Looks up an individual status context by context name.

Arguments

NameDescription
name
String!

The context name.

contexts
[StatusContext!]!

The individual status contexts for this commit.

id
ID!
state
StatusState!

The combined commit status.

StatusCheckRollup#

Represents the rollup for both the check runs and status for a commit.

Implements

Fields

NameDescription
commit
Commit

The commit the status and check runs are attached to.

contexts
StatusCheckRollupContextConnection!

A list of status contexts and check runs for this commit.

Arguments

NameDescription
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.

id
ID!
state
StatusState!

The combined status for the commit.

StatusCheckRollupContextConnection#

The connection type for StatusCheckRollupContext.

Fields

NameDescription
edges
[StatusCheckRollupContextEdge]

A list of edges.

nodes
[StatusCheckRollupContext]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

StatusCheckRollupContextEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
StatusCheckRollupContext

The item at the end of the edge.

StatusContext#

Represents an individual commit status context

Implements

Fields

NameDescription
avatarUrl
URI

The avatar of the OAuth application or the user that created the status

Arguments

NameDescription
size
Int

The size of the resulting square image.

commit
Commit

This commit this status context is attached to.

context
String!

The name of this status context.

createdAt
DateTime!

Identifies the date and time when the object was created.

creator
Actor

The actor who created this status context.

description
String

The description for this status context.

id
ID!
isRequired
Boolean!

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

Arguments

NameDescription
pullRequestId
ID

The id of the pull request this is required for

pullRequestNumber
Int

The number of the pull request this is required for

state
StatusState!

The state of this status context.

targetUrl
URI

The URL for this status context.

SubmitPullRequestReviewPayload#

Autogenerated return type of SubmitPullRequestReview

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestReview
PullRequestReview

The submitted pull request review.

Submodule#

A pointer to a repository at a specific revision embedded inside another repository.

Fields

NameDescription
branch
String

The branch of the upstream submodule for tracking updates

gitUrl
URI!

The git URL of the submodule repository

name
String!

The name of the submodule in .gitmodules

path
String!

The path in the superproject that this submodule is located in

subprojectCommitOid
GitObjectID

The commit revision of the subproject repository being tracked by the submodule

SubmoduleConnection#

The connection type for Submodule.

Fields

NameDescription
edges
[SubmoduleEdge]

A list of edges.

nodes
[Submodule]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

SubmoduleEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Submodule

The item at the end of the edge.

SubscribedEvent#

Represents a 'subscribed' event on a given Subscribable.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
subscribable
Subscribable!

Object referenced by event.

SuggestedReviewer#

A suggestion to review a pull request based on a user's commit history and review comments.

Fields

NameDescription
isAuthor
Boolean!

Is this suggestion based on past commits?

isCommenter
Boolean!

Is this suggestion based on past review comments?

reviewer
User!

Identifies the user suggested to review the pull request.

Tag#

Represents a Git tag.

Implements

Fields

NameDescription
abbreviatedOid
String!

An abbreviated version of the Git object ID

commitResourcePath
URI!

The HTTP path for this Git object

commitUrl
URI!

The HTTP URL for this Git object

id
ID!
message
String

The Git tag message.

name
String!

The Git tag name.

oid
GitObjectID!

The Git object ID

repository
Repository!

The Repository the Git object belongs to

tagger
GitActor

Details about the tag author.

target
GitObject!

The Git object the tag points to.

Team#

A team of users in an organization.

Implements

Fields

NameDescription
ancestors
TeamConnection!

A list of teams that are ancestors of this team.

Arguments

NameDescription
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.

avatarUrl
URI

A URL pointing to the team's avatar.

Arguments

NameDescription
size
Int

The size in pixels of the resulting square image.

childTeams
TeamConnection!

List of child teams belonging to this team

Arguments

NameDescription
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.

immediateOnly
Boolean

Whether to list immediate child teams or all descendant child teams.

last
Int

Returns the last n elements from the list.

orderBy
TeamOrder

Order for connection

userLogins
[String!]

User logins to filter by

combinedSlug
String!

The slug corresponding to the organization and team.

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 team.

discussion
TeamDiscussion

Find a team discussion by its number.

Arguments

NameDescription
number
Int!

The sequence number of the discussion to find.

discussions
TeamDiscussionConnection!

A list of team discussions.

Arguments

NameDescription
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.

isPinned
Boolean

If provided, filters discussions according to whether or not they are pinned.

last
Int

Returns the last n elements from the list.

orderBy
TeamDiscussionOrder

Order for connection

discussionsResourcePath
URI!

The HTTP path for team discussions

discussionsUrl
URI!

The HTTP URL for team discussions

editTeamResourcePath
URI!

The HTTP path for editing this team

editTeamUrl
URI!

The HTTP URL for editing this team

id
ID!
invitations
OrganizationInvitationConnection

A list of pending invitations for users to this team

Arguments

NameDescription
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.

memberStatuses
UserStatusConnection!

Get the status messages members of this entity have set that are either public or visible only to the organization.

Arguments

NameDescription
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
UserStatusOrder

Ordering options for user statuses returned from the connection.

members
TeamMemberConnection!

A list of users who are members of this team.

Arguments

NameDescription
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.

membership
TeamMembershipType

Filter by membership type

orderBy
TeamMemberOrder

Order for the connection.

query
String

The search string to look for.

role
TeamMemberRole

Filter by team member role

membersResourcePath
URI!

The HTTP path for the team' members

membersUrl
URI!

The HTTP URL for the team' members

name
String!

The name of the team.

newTeamResourcePath
URI!

The HTTP path creating a new team

newTeamUrl
URI!

The HTTP URL creating a new team

organization
Organization!

The organization that owns this team.

parentTeam
Team

The parent team of the team.

privacy
TeamPrivacy!

The level of privacy the team has.

repositories
TeamRepositoryConnection!

A list of repositories this team has access to.

Arguments

NameDescription
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
TeamRepositoryOrder

Order for the connection.

query
String

The search string to look for.

repositoriesResourcePath
URI!

The HTTP path for this team's repositories

repositoriesUrl
URI!

The HTTP URL for this team's repositories

resourcePath
URI!

The HTTP path for this team

reviewRequestDelegationAlgorithm
TeamReviewAssignmentAlgorithm

What algorithm is used for review assignment for this team

reviewRequestDelegationEnabled
Boolean!

True if review assignment is enabled for this team

reviewRequestDelegationMemberCount
Int

How many team members are required for review assignment for this team

reviewRequestDelegationNotifyTeam
Boolean!

When assigning team members via delegation, whether the entire team should be notified as well.

slug
String!

The slug corresponding to the team.

teamsResourcePath
URI!

The HTTP path for this team's teams

teamsUrl
URI!

The HTTP URL for this team's teams

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this team

viewerCanAdminister
Boolean!

Team is adminable by the viewer.

viewerCanSubscribe
Boolean!

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

viewerSubscription
SubscriptionState

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

TeamAddMemberAuditEntry#

Audit log entry for a team.add_member event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
isLdapMapped
Boolean

Whether the team was mapped to an LDAP Group.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

team
Team

The team associated with the action

teamName
String

The name of the team

teamResourcePath
URI

The HTTP path for this team

teamUrl
URI

The HTTP URL for this team

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

TeamAddRepositoryAuditEntry#

Audit log entry for a team.add_repository event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
isLdapMapped
Boolean

Whether the team was mapped to an LDAP Group.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

team
Team

The team associated with the action

teamName
String

The name of the team

teamResourcePath
URI

The HTTP path for this team

teamUrl
URI

The HTTP URL for this team

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

TeamChangeParentTeamAuditEntry#

Audit log entry for a team.change_parent_team event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
isLdapMapped
Boolean

Whether the team was mapped to an LDAP Group.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

parentTeam
Team

The new parent team.

parentTeamName
String

The name of the new parent team

parentTeamNameWas
String

The name of the former parent team

parentTeamResourcePath
URI

The HTTP path for the parent team

parentTeamUrl
URI

The HTTP URL for the parent team

parentTeamWas
Team

The former parent team.

parentTeamWasResourcePath
URI

The HTTP path for the previous parent team

parentTeamWasUrl
URI

The HTTP URL for the previous parent team

team
Team

The team associated with the action

teamName
String

The name of the team

teamResourcePath
URI

The HTTP path for this team

teamUrl
URI

The HTTP URL for this team

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

TeamConnection#

The connection type for Team.

Fields

NameDescription
edges
[TeamEdge]

A list of edges.

nodes
[Team]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

TeamDiscussion#

A team discussion.

Implements

Fields

NameDescription
author
Actor

The actor who authored the comment.

authorAssociation
CommentAuthorAssociation!

Author's association with the discussion's team.

body
String!

The body as Markdown.

bodyHTML
HTML!

The body rendered to HTML.

bodyText
String!

The body rendered to text.

bodyVersion
String!

Identifies the discussion body hash.

comments
TeamDiscussionCommentConnection!

A list of comments on this discussion.

Arguments

NameDescription
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.

fromComment
Int

When provided, filters the connection such that results begin with the comment with this number.

last
Int

Returns the last n elements from the list.

orderBy
TeamDiscussionCommentOrder

Order for connection

commentsResourcePath
URI!

The HTTP path for discussion comments

commentsUrl
URI!

The HTTP URL for discussion comments

createdAt
DateTime!

Identifies the date and time when the object was created.

createdViaEmail
Boolean!

Check if this comment was created via an email reply.

databaseId
Int

Identifies the primary key from the database.

editor
Actor

The actor who edited the comment.

id
ID!
includesCreatedEdit
Boolean!

Check if this comment was edited and includes an edit with the creation data

isPinned
Boolean!

Whether or not the discussion is pinned.

isPrivate
Boolean!

Whether or not the discussion is only visible to team members and org admins.

lastEditedAt
DateTime

The moment the editor made the last edit

number
Int!

Identifies the discussion within its team.

publishedAt
DateTime

Identifies when the comment was published at.

reactionGroups
[ReactionGroup!]

A list of reactions grouped by content left on the subject.

reactions
ReactionConnection!

A list of Reactions left on the Issue.

Arguments

NameDescription
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.

content
ReactionContent

Allows filtering Reactions by emoji.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ReactionOrder

Allows specifying the order in which reactions are returned.

resourcePath
URI!

The HTTP path for this discussion

team
Team!

The team that defines the context of this discussion.

title
String!

The title of the discussion

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this discussion

userContentEdits
UserContentEditConnection

A list of edits to this content.

Arguments

NameDescription
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.

viewerCanDelete
Boolean!

Check if the current viewer can delete this object.

viewerCanPin
Boolean!

Whether or not the current viewer can pin this discussion.

viewerCanReact
Boolean!

Can user react to this subject

viewerCanSubscribe
Boolean!

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

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

viewerCannotUpdateReasons
[CommentCannotUpdateReason!]!

Reasons why the current viewer can not update this comment.

viewerDidAuthor
Boolean!

Did the viewer author this comment.

viewerSubscription
SubscriptionState

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

TeamDiscussionComment#

A comment on a team discussion.

Implements

Fields

NameDescription
author
Actor

The actor who authored the comment.

authorAssociation
CommentAuthorAssociation!

Author's association with the comment's team.

body
String!

The body as Markdown.

bodyHTML
HTML!

The body rendered to HTML.

bodyText
String!

The body rendered to text.

bodyVersion
String!

The current version of the body content.

createdAt
DateTime!

Identifies the date and time when the object was created.

createdViaEmail
Boolean!

Check if this comment was created via an email reply.

databaseId
Int

Identifies the primary key from the database.

discussion
TeamDiscussion!

The discussion this comment is about.

editor
Actor

The actor who edited the comment.

id
ID!
includesCreatedEdit
Boolean!

Check if this comment was edited and includes an edit with the creation data

lastEditedAt
DateTime

The moment the editor made the last edit

number
Int!

Identifies the comment number.

publishedAt
DateTime

Identifies when the comment was published at.

reactionGroups
[ReactionGroup!]

A list of reactions grouped by content left on the subject.

reactions
ReactionConnection!

A list of Reactions left on the Issue.

Arguments

NameDescription
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.

content
ReactionContent

Allows filtering Reactions by emoji.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

orderBy
ReactionOrder

Allows specifying the order in which reactions are returned.

resourcePath
URI!

The HTTP path for this comment

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this comment

userContentEdits
UserContentEditConnection

A list of edits to this content.

Arguments

NameDescription
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.

viewerCanDelete
Boolean!

Check if the current viewer can delete this object.

viewerCanReact
Boolean!

Can user react to this subject

viewerCanUpdate
Boolean!

Check if the current viewer can update this object.

viewerCannotUpdateReasons
[CommentCannotUpdateReason!]!

Reasons why the current viewer can not update this comment.

viewerDidAuthor
Boolean!

Did the viewer author this comment.

TeamDiscussionCommentConnection#

The connection type for TeamDiscussionComment.

Fields

NameDescription
edges
[TeamDiscussionCommentEdge]

A list of edges.

nodes
[TeamDiscussionComment]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

TeamDiscussionCommentEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
TeamDiscussionComment

The item at the end of the edge.

TeamDiscussionConnection#

The connection type for TeamDiscussion.

Fields

NameDescription
edges
[TeamDiscussionEdge]

A list of edges.

nodes
[TeamDiscussion]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

TeamDiscussionEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
TeamDiscussion

The item at the end of the edge.

TeamEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Team

The item at the end of the edge.

TeamMemberConnection#

The connection type for User.

Fields

NameDescription
edges
[TeamMemberEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

TeamMemberEdge#

Represents a user who is a member of a team.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

memberAccessResourcePath
URI!

The HTTP path to the organization's member access page.

memberAccessUrl
URI!

The HTTP URL to the organization's member access page.

node
User!
role
TeamMemberRole!

The role the member has on the team.

TeamRemoveMemberAuditEntry#

Audit log entry for a team.remove_member event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
isLdapMapped
Boolean

Whether the team was mapped to an LDAP Group.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

team
Team

The team associated with the action

teamName
String

The name of the team

teamResourcePath
URI

The HTTP path for this team

teamUrl
URI

The HTTP URL for this team

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

TeamRemoveRepositoryAuditEntry#

Audit log entry for a team.remove_repository event.

Implements

Fields

NameDescription
action
String!

The action name

actor
AuditEntryActor

The user who initiated the action

actorIp
String

The IP address of the actor

actorLocation
ActorLocation

A readable representation of the actor's location

actorLogin
String

The username of the user who initiated the action

actorResourcePath
URI

The HTTP path for the actor.

actorUrl
URI

The HTTP URL for the actor.

createdAt
PreciseDateTime!

The time the action was initiated

id
ID!
isLdapMapped
Boolean

Whether the team was mapped to an LDAP Group.

operationType
OperationType

The corresponding operation type for the action

organization
Organization

The Organization associated with the Audit Entry.

organizationName
String

The name of the Organization.

organizationResourcePath
URI

The HTTP path for the organization

organizationUrl
URI

The HTTP URL for the organization

repository
Repository

The repository associated with the action

repositoryName
String

The name of the repository

repositoryResourcePath
URI

The HTTP path for the repository

repositoryUrl
URI

The HTTP URL for the repository

team
Team

The team associated with the action

teamName
String

The name of the team

teamResourcePath
URI

The HTTP path for this team

teamUrl
URI

The HTTP URL for this team

user
User

The user affected by the action

userLogin
String

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath
URI

The HTTP path for the user.

userUrl
URI

The HTTP URL for the user.

TeamRepositoryConnection#

The connection type for Repository.

Fields

NameDescription
edges
[TeamRepositoryEdge]

A list of edges.

nodes
[Repository]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

TeamRepositoryEdge#

Represents a team repository.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
Repository!
permission
RepositoryPermission!

The permission level the team has on the repository

TextMatch#

A text match within a search result.

Fields

NameDescription
fragment
String!

The specific text fragment within the property matched on.

highlights
[TextMatchHighlight!]!

Highlights within the matched fragment.

property
String!

The property matched on.

TextMatchHighlight#

Represents a single highlight in a search result match.

Fields

NameDescription
beginIndice
Int!

The indice in the fragment where the matched text begins.

endIndice
Int!

The indice in the fragment where the matched text ends.

text
String!

The text matched.

Topic#

A topic aggregates entities that are related to a subject.

Implements

Fields

NameDescription
id
ID!
name
String!

The topic's name.

relatedTopics
[Topic!]!

A list of related topics, including aliases of this topic, sorted with the most relevant first. Returns up to 10 Topics.

Arguments

NameDescription
first
Int

How many topics to return.

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.

Arguments

NameDescription
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
StarOrder

Order for connection

viewerHasStarred
Boolean!

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

TransferIssuePayload#

Autogenerated return type of TransferIssue

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issue
Issue

The issue that was transferred

TransferredEvent#

Represents a 'transferred' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

fromRepository
Repository

The repository this came from

id
ID!
issue
Issue!

Identifies the issue associated with the event.

Tree#

Represents a Git tree.

Implements

Fields

NameDescription
abbreviatedOid
String!

An abbreviated version of the Git object ID

commitResourcePath
URI!

The HTTP path for this Git object

commitUrl
URI!

The HTTP URL for this Git object

entries
[TreeEntry!]

A list of tree entries.

id
ID!
oid
GitObjectID!

The Git object ID

repository
Repository!

The Repository the Git object belongs to

TreeEntry#

Represents a Git tree entry.

Fields

NameDescription
extension
String

The extension of the file

isGenerated
Boolean!

Whether or not this tree entry is generated

mode
Int!

Entry file mode.

name
String!

Entry file name.

object
GitObject

Entry file object.

oid
GitObjectID!

Entry file Git object ID.

path
String

The full path of the file.

repository
Repository!

The Repository the tree entry belongs to

submodule
Submodule

If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule

type
String!

Entry file type.

UnarchiveRepositoryPayload#

Autogenerated return type of UnarchiveRepository

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repository
Repository

The repository that was unarchived.

UnassignedEvent#

Represents an 'unassigned' event on any assignable object.

Implements

Fields

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 unassigned.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
user
User
Deprecated: Assignees can now be mannequins. Use the `assignee` field instead. Removal on 2020-01-01 UTC.

Identifies the subject (user) who was unassigned.

UnfollowUserPayload#

Autogenerated return type of UnfollowUser

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

user
User

The user that was unfollowed.

UnknownSignature#

Represents an unknown signature on a Commit or Tag.

Implements

Fields

NameDescription
email
String!

Email used to sign this object.

isValid
Boolean!

True if the signature is valid and verified by GitHub.

payload
String!

Payload for GPG signing object. Raw ODB object without the signature header.

signature
String!

ASCII-armored signature header from object.

signer
User

GitHub user corresponding to the email signing this commit.

state
GitSignatureState!

The state of this signature. VALID if signature is valid and verified by GitHub, otherwise represents reason why signature is considered invalid.

wasSignedByGitHub
Boolean!

True if the signature was made with GitHub's signing key.

UnlabeledEvent#

Represents an 'unlabeled' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
label
Label!

Identifies the label associated with the 'unlabeled' event.

labelable
Labelable!

Identifies the Labelable associated with the event.

UnlinkRepositoryFromProjectPayload#

Autogenerated return type of UnlinkRepositoryFromProject

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

project
Project

The linked Project.

repository
Repository

The linked Repository.

UnlockedEvent#

Represents an 'unlocked' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
lockable
Lockable!

Object that was unlocked.

UnlockLockablePayload#

Autogenerated return type of UnlockLockable

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

clientMutationId
String

A unique identifier for the client performing the mutation.

unlockedRecord
Lockable

The item that was unlocked.

UnmarkedAsDuplicateEvent#

Represents an 'unmarked_as_duplicate' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

canonical
IssueOrPullRequest

The authoritative issue or pull request which has been duplicated by another.

createdAt
DateTime!

Identifies the date and time when the object was created.

duplicate
IssueOrPullRequest

The issue or pull request which has been marked as a duplicate of another.

id
ID!
isCrossRepository
Boolean!

Canonical and duplicate belong to different repositories.

UnmarkFileAsViewedPayload#

Autogenerated return type of UnmarkFileAsViewed

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The updated pull request.

UnmarkIssueAsDuplicatePayload#

Autogenerated return type of UnmarkIssueAsDuplicate

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

duplicate
IssueOrPullRequest

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

UnminimizeCommentPayload#

Autogenerated return type of UnminimizeComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

unminimizedComment
Minimizable

The comment that was unminimized.

UnpinIssuePayload#

Autogenerated return type of UnpinIssue

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issue
Issue

The issue that was unpinned

UnpinnedEvent#

Represents an 'unpinned' event on a given issue or pull request.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
issue
Issue!

Identifies the issue associated with the event.

UnresolveReviewThreadPayload#

Autogenerated return type of UnresolveReviewThread

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

thread
PullRequestReviewThread

The thread to resolve.

UnsubscribedEvent#

Represents an 'unsubscribed' event on a given Subscribable.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
subscribable
Subscribable!

Object referenced by event.

UpdateBranchProtectionRulePayload#

Autogenerated return type of UpdateBranchProtectionRule

Fields

NameDescription
branchProtectionRule
BranchProtectionRule

The newly created BranchProtectionRule.

clientMutationId
String

A unique identifier for the client performing the mutation.

UpdateCheckRunPayload#

Autogenerated return type of UpdateCheckRun

Fields

NameDescription
checkRun
CheckRun

The updated check run.

clientMutationId
String

A unique identifier for the client performing the mutation.

UpdateCheckSuitePreferencesPayload#

Autogenerated return type of UpdateCheckSuitePreferences

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repository
Repository

The updated repository.

UpdateEnterpriseAdministratorRolePayload#

Autogenerated return type of UpdateEnterpriseAdministratorRole

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

message
String

A message confirming the result of changing the administrator's role.

UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload#

Autogenerated return type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated allow private repository forking setting.

message
String

A message confirming the result of updating the allow private repository forking setting.

UpdateEnterpriseDefaultRepositoryPermissionSettingPayload#

Autogenerated return type of UpdateEnterpriseDefaultRepositoryPermissionSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated default repository permission setting.

message
String

A message confirming the result of updating the default repository permission setting.

UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload#

Autogenerated return type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated members can change repository visibility setting.

message
String

A message confirming the result of updating the members can change repository visibility setting.

UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload#

Autogenerated return type of UpdateEnterpriseMembersCanCreateRepositoriesSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated members can create repositories setting.

message
String

A message confirming the result of updating the members can create repositories setting.

UpdateEnterpriseMembersCanDeleteIssuesSettingPayload#

Autogenerated return type of UpdateEnterpriseMembersCanDeleteIssuesSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated members can delete issues setting.

message
String

A message confirming the result of updating the members can delete issues setting.

UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload#

Autogenerated return type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated members can delete repositories setting.

message
String

A message confirming the result of updating the members can delete repositories setting.

UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload#

Autogenerated return type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated members can invite collaborators setting.

message
String

A message confirming the result of updating the members can invite collaborators setting.

UpdateEnterpriseMembersCanMakePurchasesSettingPayload#

Autogenerated return type of UpdateEnterpriseMembersCanMakePurchasesSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated members can make purchases setting.

message
String

A message confirming the result of updating the members can make purchases setting.

UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload#

Autogenerated return type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated members can update protected branches setting.

message
String

A message confirming the result of updating the members can update protected branches setting.

UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload#

Autogenerated return type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated members can view dependency insights setting.

message
String

A message confirming the result of updating the members can view dependency insights setting.

UpdateEnterpriseOrganizationProjectsSettingPayload#

Autogenerated return type of UpdateEnterpriseOrganizationProjectsSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated organization projects setting.

message
String

A message confirming the result of updating the organization projects setting.

UpdateEnterpriseProfilePayload#

Autogenerated return type of UpdateEnterpriseProfile

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The updated enterprise.

UpdateEnterpriseRepositoryProjectsSettingPayload#

Autogenerated return type of UpdateEnterpriseRepositoryProjectsSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated repository projects setting.

message
String

A message confirming the result of updating the repository projects setting.

UpdateEnterpriseTeamDiscussionsSettingPayload#

Autogenerated return type of UpdateEnterpriseTeamDiscussionsSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated team discussions setting.

message
String

A message confirming the result of updating the team discussions setting.

UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload#

Autogenerated return type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterprise
Enterprise

The enterprise with the updated two factor authentication required setting.

message
String

A message confirming the result of updating the two factor authentication required setting.

UpdateIpAllowListEnabledSettingPayload#

Autogenerated return type of UpdateIpAllowListEnabledSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

owner
IpAllowListOwner

The IP allow list owner on which the setting was updated.

UpdateIpAllowListEntryPayload#

Autogenerated return type of UpdateIpAllowListEntry

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

ipAllowListEntry
IpAllowListEntry

The IP allow list entry that was updated.

UpdateIssueCommentPayload#

Autogenerated return type of UpdateIssueComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issueComment
IssueComment

The updated comment.

UpdateIssuePayload#

Autogenerated return type of UpdateIssue

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

clientMutationId
String

A unique identifier for the client performing the mutation.

issue
Issue

The issue.

UpdateLabelPayload#

Autogenerated return type of UpdateLabel

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

label
Label

The updated label.

UpdateNotificationRestrictionSettingPayload#

Autogenerated return type of UpdateNotificationRestrictionSetting

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

owner
VerifiableDomainOwner

The owner on which the setting was updated.

UpdateProjectCardPayload#

Autogenerated return type of UpdateProjectCard

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

projectCard
ProjectCard

The updated ProjectCard.

UpdateProjectColumnPayload#

Autogenerated return type of UpdateProjectColumn

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

projectColumn
ProjectColumn

The updated project column.

UpdateProjectPayload#

Autogenerated return type of UpdateProject

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

project
Project

The updated project.

UpdatePullRequestPayload#

Autogenerated return type of UpdatePullRequest

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequest
PullRequest

The updated pull request.

UpdatePullRequestReviewCommentPayload#

Autogenerated return type of UpdatePullRequestReviewComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestReviewComment
PullRequestReviewComment

The updated comment.

UpdatePullRequestReviewPayload#

Autogenerated return type of UpdatePullRequestReview

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestReview
PullRequestReview

The updated pull request review.

UpdateRefPayload#

Autogenerated return type of UpdateRef

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

ref
Ref

The updated Ref.

UpdateRefsPayload#

Autogenerated return type of UpdateRefs

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

UpdateRepositoryPayload#

Autogenerated return type of UpdateRepository

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repository
Repository

The updated repository.

UpdateSubscriptionPayload#

Autogenerated return type of UpdateSubscription

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

subscribable
Subscribable

The input subscribable entity.

UpdateTeamDiscussionCommentPayload#

Autogenerated return type of UpdateTeamDiscussionComment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

teamDiscussionComment
TeamDiscussionComment

The updated comment.

UpdateTeamDiscussionPayload#

Autogenerated return type of UpdateTeamDiscussion

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

teamDiscussion
TeamDiscussion

The updated discussion.

UpdateTeamReviewAssignmentPayload#

Autogenerated return type of UpdateTeamReviewAssignment

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

team
Team

The team that was modified

UpdateTopicsPayload#

Autogenerated return type of UpdateTopics

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

invalidTopicNames
[String!]

Names of the provided topics that are not valid.

repository
Repository

The updated repository.

User#

A user is an individual's account on GitHub that owns repositories and can make new content.

Implements

Fields

NameDescription
anyPinnableItems
Boolean!

Determine if this repository owner has any items that can be pinned to their profile.

Arguments

NameDescription
type
PinnableItemType

Filter to only a particular kind of pinnable item.

avatarUrl
URI!

A URL pointing to the user's public avatar.

Arguments

NameDescription
size
Int

The size of the resulting square image.

bio
String

The user's public profile bio.

bioHTML
HTML!

The user's public profile bio as HTML.

commitComments
CommitCommentConnection!

A list of commit comments made by this user.

Arguments

NameDescription
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.

company
String

The user's public profile company.

companyHTML
HTML!

The user's public profile company as HTML.

contributionsCollection
ContributionsCollection!

The collection of contributions this user has made to different repositories.

Arguments

NameDescription
from
DateTime

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

organizationID
ID

The ID of the organization used to filter contributions.

to
DateTime

Only contributions made before and up to and including this time will be counted. If omitted, defaults to the current time.

createdAt
DateTime!

Identifies the date and time when the object was created.

databaseId
Int

Identifies the primary key from the database.

email
String!

The user's publicly visible profile email.

followers
FollowerConnection!

A list of users the given user is followed by.

Arguments

NameDescription
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.

following
FollowingConnection!

A list of users the given user is following.

Arguments

NameDescription
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.

gist
Gist

Find gist by repo name.

Arguments

NameDescription
name
String!

The gist name to find.

gistComments
GistCommentConnection!

A list of gist comments made by this user.

Arguments

NameDescription
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.

gists
GistConnection!

A list of the Gists the user has created.

Arguments

NameDescription
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
GistOrder

Ordering options for gists returned from the connection

privacy
GistPrivacy

Filters Gists according to privacy.

hasSponsorsListing
Boolean!

True if this user/organization has a GitHub Sponsors listing.

hovercard
Hovercard!

The hovercard information for this user in a given context

Arguments

NameDescription
primarySubjectId
ID

The ID of the subject to get the hovercard in the context of

id
ID!
interactionAbility
RepositoryInteractionAbility

The interaction ability settings for this user.

isBountyHunter
Boolean!

Whether or not this user is a participant in the GitHub Security Bug Bounty.

isCampusExpert
Boolean!

Whether or not this user is a participant in the GitHub Campus Experts Program.

isDeveloperProgramMember
Boolean!

Whether or not this user is a GitHub Developer Program member.

isEmployee
Boolean!

Whether or not this user is a GitHub employee.

isGitHubStar
Boolean!

Whether or not this user is a member of the GitHub Stars Program.

isHireable
Boolean!

Whether or not the user has marked themselves as for hire.

isSiteAdmin
Boolean!

Whether or not this user is a site administrator.

isSponsoredBy
Boolean!

Check if the given account is sponsoring this user/organization.

Arguments

NameDescription
accountLogin
String!

The target account's login.

isSponsoringViewer
Boolean!

True if the viewer is sponsored by this user/organization.

isViewer
Boolean!

Whether or not this user is the viewing user.

issueComments
IssueCommentConnection!

A list of issue comments made by this user.

Arguments

NameDescription
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
IssueCommentOrder

Ordering options for issue comments returned from the connection.

issues
IssueConnection!

A list of issues associated with this user.

Arguments

NameDescription
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.

filterBy
IssueFilters

Filtering options for issues returned from the connection.

first
Int

Returns the first n elements from the list.

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 issues returned from the connection.

states
[IssueState!]

A list of states to filter the issues by.

itemShowcase
ProfileItemShowcase!

Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity.

location
String

The user's public profile location.

login
String!

The username used to login.

name
String

The user's public profile name.

organization
Organization

Find an organization by its login that the user belongs to.

Arguments

NameDescription
login
String!

The login of the organization to find.

organizationVerifiedDomainEmails
[String!]!

Verified email addresses that match verified domains for a specified organization the user is a member of.

Arguments

NameDescription
login
String!

The login of the organization to match verified domains from.

organizations
OrganizationConnection!

A list of organizations the user belongs to.

Arguments

NameDescription
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.

packages
PackageConnection!

A list of packages under the owner.

Arguments

NameDescription
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.

names
[String]

Find packages by their names.

orderBy
PackageOrder

Ordering of the returned packages.

packageType
PackageType

Filter registry package by type.

repositoryId
ID

Find packages in a repository by ID.

pinnableItems
PinnableItemConnection!

A list of repositories and gists this profile owner can pin to their profile.

Arguments

NameDescription
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.

types
[PinnableItemType!]

Filter the types of pinnable items that are returned.

pinnedItems
PinnableItemConnection!

A list of repositories and gists this profile owner has pinned to their profile

Arguments

NameDescription
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.

types
[PinnableItemType!]

Filter the types of pinned items that are returned.

pinnedItemsRemaining
Int!

Returns how many more items this profile owner can pin to their profile.

project
Project

Find project by number.

Arguments

NameDescription
number
Int!

The project number to find.

projects
ProjectConnection!

A list of projects under the owner.

Arguments

NameDescription
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
ProjectOrder

Ordering options for projects returned from the connection

search
String

Query to search projects by, currently only searching by name.

states
[ProjectState!]

A list of states to filter the projects by.

projectsResourcePath
URI!

The HTTP path listing user's projects

projectsUrl
URI!

The HTTP URL listing user's projects

publicKeys
PublicKeyConnection!

A list of public keys associated with this user.

Arguments

NameDescription
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.

pullRequests
PullRequestConnection!

A list of pull requests associated with this user.

Arguments

NameDescription
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.

states
[PullRequestState!]

A list of states to filter the pull requests by.

repositories
RepositoryConnection!

A list of repositories that the user owns.

Arguments

NameDescription
affiliations
[RepositoryAffiliation]

Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.

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.

isFork
Boolean

If non-null, filters repositories according to whether they are forks of another repository

isLocked
Boolean

If non-null, filters repositories according to whether they have been locked

last
Int

Returns the last n elements from the list.

orderBy
RepositoryOrder

Ordering options for repositories returned from the connection

ownerAffiliations
[RepositoryAffiliation]

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

privacy
RepositoryPrivacy

If non-null, filters repositories according to privacy

repositoriesContributedTo
RepositoryConnection!

A list of repositories that the user recently contributed to.

Arguments

NameDescription
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.

contributionTypes
[RepositoryContributionType]

If non-null, include only the specified types of contributions. The GitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]

first
Int

Returns the first n elements from the list.

includeUserRepositories
Boolean

If true, include user repositories

isLocked
Boolean

If non-null, filters repositories according to whether they have been locked

last
Int

Returns the last n elements from the list.

orderBy
RepositoryOrder

Ordering options for repositories returned from the connection

privacy
RepositoryPrivacy

If non-null, filters repositories according to privacy

repository
Repository

Find Repository.

Arguments

NameDescription
name
String!

Name of Repository to find.

resourcePath
URI!

The HTTP path for this user

savedReplies
SavedReplyConnection

Replies this user has saved

Arguments

NameDescription
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
SavedReplyOrder

The field to order saved replies by.

sponsorsListing
SponsorsListing

The GitHub Sponsors listing for this user or organization.

sponsorshipForViewerAsSponsor
Sponsorship

The viewer's sponsorship of this entity.

sponsorshipsAsMaintainer
SponsorshipConnection!

This object's sponsorships as the maintainer.

Arguments

NameDescription
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.

includePrivate
Boolean

Whether or not to include private sponsorships in the result set

last
Int

Returns the last n elements from the list.

orderBy
SponsorshipOrder

Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.

sponsorshipsAsSponsor
SponsorshipConnection!

This object's sponsorships as the sponsor.

Arguments

NameDescription
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
SponsorshipOrder

Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.

starredRepositories
StarredRepositoryConnection!

Repositories the user has starred.

Arguments

NameDescription
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
StarOrder

Order for connection

ownedByViewer
Boolean

Filters starred repositories to only return repositories owned by the viewer.

status
UserStatus

The user's description of what they're currently doing.

topRepositories
RepositoryConnection!

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created

Arguments

NameDescription
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
RepositoryOrder!

Ordering options for repositories returned from the connection

since
DateTime

How far back in time to fetch contributed repositories

twitterUsername
String

The user's Twitter username.

updatedAt
DateTime!

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

url
URI!

The HTTP URL for this user

viewerCanChangePinnedItems
Boolean!

Can the viewer pin repositories and gists to the profile?

viewerCanCreateProjects
Boolean!

Can the current viewer create new projects on this owner.

viewerCanFollow
Boolean!

Whether or not the viewer is able to follow the user.

viewerCanSponsor
Boolean!

Whether or not the viewer is able to sponsor this user/organization.

viewerIsFollowing
Boolean!

Whether or not this user is followed by the viewer.

viewerIsSponsoring
Boolean!

True if the viewer is sponsoring this user/organization.

watching
RepositoryConnection!

A list of repositories the given user is watching.

Arguments

NameDescription
affiliations
[RepositoryAffiliation]

Affiliation options for repositories returned from the connection. If none specified, the results will include repositories for which the current viewer is an owner or collaborator, or member.

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.

isLocked
Boolean

If non-null, filters repositories according to whether they have been locked

last
Int

Returns the last n elements from the list.

orderBy
RepositoryOrder

Ordering options for repositories returned from the connection

ownerAffiliations
[RepositoryAffiliation]

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

privacy
RepositoryPrivacy

If non-null, filters repositories according to privacy

websiteUrl
URI

A URL pointing to the user's public website/blog.

UserBlockedEvent#

Represents a 'user_blocked' event on a given user.

Implements

Fields

NameDescription
actor
Actor

Identifies the actor who performed the event.

blockDuration
UserBlockDuration!

Number of days that the user was blocked for.

createdAt
DateTime!

Identifies the date and time when the object was created.

id
ID!
subject
User

The user who was blocked.

UserConnection#

The connection type for User.

Fields

NameDescription
edges
[UserEdge]

A list of edges.

nodes
[User]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

UserContentEdit#

An edit on user content

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

deletedAt
DateTime

Identifies the date and time when the object was deleted.

deletedBy
Actor

The actor who deleted this content

diff
String

A summary of the changes for this edit

editedAt
DateTime!

When this content was edited

editor
Actor

The actor who edited this content

id
ID!
updatedAt
DateTime!

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

UserContentEditConnection#

A list of edits to content.

Fields

NameDescription
edges
[UserContentEditEdge]

A list of edges.

nodes
[UserContentEdit]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

UserContentEditEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
UserContentEdit

The item at the end of the edge.

UserEdge#

Represents a user.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
User

The item at the end of the edge.

UserEmailMetadata#

Email attributes from External Identity

Fields

NameDescription
primary
Boolean

Boolean to identify primary emails

type
String

Type of email

value
String!

Email id

UserStatus#

The user's description of what they're currently doing.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

emoji
String

An emoji summarizing the user's status.

emojiHTML
HTML

The status emoji as HTML.

expiresAt
DateTime

If set, the status will not be shown after this date.

id
ID!

ID of the object.

indicatesLimitedAvailability
Boolean!

Whether this status indicates the user is not fully available on GitHub.

message
String

A brief message describing what the user is doing.

organization
Organization

The organization whose members can see this status. If null, this status is publicly visible.

updatedAt
DateTime!

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

user
User!

The user who has this status.

UserStatusConnection#

The connection type for UserStatus.

Fields

NameDescription
edges
[UserStatusEdge]

A list of edges.

nodes
[UserStatus]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

UserStatusEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
UserStatus

The item at the end of the edge.

VerifiableDomain#

A domain that can be verified for an organization or an enterprise.

Implements

Fields

NameDescription
createdAt
DateTime!

Identifies the date and time when the object was created.

databaseId
Int

Identifies the primary key from the database.

dnsHostName
URI

The DNS host name that should be used for verification.

domain
URI!

The unicode encoded domain.

hasFoundHostName
Boolean!

Whether a TXT record for verification with the expected host name was found.

hasFoundVerificationToken
Boolean!

Whether a TXT record for verification with the expected verification token was found.

id
ID!
isRequiredForPolicyEnforcement
Boolean!

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

isVerified
Boolean!

Whether or not the domain is verified.

owner
VerifiableDomainOwner!

The owner of the domain.

punycodeEncodedDomain
URI!

The punycode encoded domain.

tokenExpirationTime
DateTime

The time that the current verification token will expire.

updatedAt
DateTime!

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

verificationToken
String

The current verification token for the domain.

VerifiableDomainConnection#

The connection type for VerifiableDomain.

Fields

NameDescription
edges
[VerifiableDomainEdge]

A list of edges.

nodes
[VerifiableDomain]

A list of nodes.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

VerifiableDomainEdge#

An edge in a connection.

Fields

NameDescription
cursor
String!

A cursor for use in pagination.

node
VerifiableDomain

The item at the end of the edge.

VerifyVerifiableDomainPayload#

Autogenerated return type of VerifyVerifiableDomain

Fields

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

domain
VerifiableDomain

The verifiable domain that was verified.

ViewerHovercardContext#

A hovercard context with a message describing how the viewer is related.

Implements

Fields

NameDescription
message
String!

A string describing this context

octicon
String!

An octicon to accompany this context

viewer
User!

Identifies the user who is related to this context.