Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
"""Autogenerated input type of AcceptTopicSuggestion"""
input AcceptTopicSuggestionInput {
"""The Node ID of the repository."""
repositoryId: ID!
"""The name of the suggested topic."""
name: String!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AcceptTopicSuggestion"""
type AcceptTopicSuggestionPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The accepted topic."""
topic: Topic
}
"""
Represents an object which can take actions on GitHub. Typically a User or Bot.
"""
interface Actor {
"""A URL pointing to the actor's public avatar."""
avatarUrl(
"""The size of the resulting square image."""
size: Int
): URI!
"""The username of the actor."""
login: String!
"""The HTTP path for this actor."""
resourcePath: URI!
"""The HTTP URL for this actor."""
url: URI!
}
"""Autogenerated input type of AddComment"""
input AddCommentInput {
"""The Node ID of the subject to modify."""
subjectId: ID!
"""The contents of the comment."""
body: String!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddComment"""
type AddCommentPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The edge from the subject's comment connection."""
commentEdge: IssueCommentEdge
"""The subject"""
subject: Node
"""The edge from the subject's timeline connection."""
timelineEdge: IssueTimelineItemEdge
}
"""
Represents a 'added_to_project' event on a given issue or pull request.
"""
type AddedToProjectEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
}
"""Autogenerated input type of AddProjectCard"""
input AddProjectCardInput {
"""The Node ID of the ProjectColumn."""
projectColumnId: ID!
"""
The content of the card. Must be a member of the ProjectCardItem union
"""
contentId: ID
"""The note on the card."""
note: String
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddProjectCard"""
type AddProjectCardPayload {
"""The edge from the ProjectColumn's card connection."""
cardEdge: ProjectCardEdge
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The ProjectColumn"""
projectColumn: ProjectColumn
}
"""Autogenerated input type of AddProjectColumn"""
input AddProjectColumnInput {
"""The Node ID of the project."""
projectId: ID!
"""The name of the column."""
name: String!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddProjectColumn"""
type AddProjectColumnPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The edge from the project's column connection."""
columnEdge: ProjectColumnEdge
"""The project"""
project: Project
}
"""Autogenerated input type of AddPullRequestReviewComment"""
input AddPullRequestReviewCommentInput {
"""The Node ID of the review to modify."""
pullRequestReviewId: ID!
"""The SHA of the commit to comment on."""
commitOID: GitObjectID
"""The text of the comment."""
body: String!
"""The relative path of the file to comment on."""
path: String
"""The line index in the diff to comment on."""
position: Int
"""The comment id to reply to."""
inReplyTo: ID
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddPullRequestReviewComment"""
type AddPullRequestReviewCommentPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The newly created comment."""
comment: PullRequestReviewComment
"""The edge from the review's comment connection."""
commentEdge: PullRequestReviewCommentEdge
}
"""Autogenerated input type of AddPullRequestReview"""
input AddPullRequestReviewInput {
"""The Node ID of the pull request to modify."""
pullRequestId: ID!
"""The commit OID the review pertains to."""
commitOID: GitObjectID
"""The contents of the review body comment."""
body: String
"""The event to perform on the pull request review."""
event: PullRequestReviewEvent
"""The review line comments."""
comments: [DraftPullRequestReviewComment]
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddPullRequestReview"""
type AddPullRequestReviewPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The newly created pull request review."""
pullRequestReview: PullRequestReview
"""The edge from the pull request's review connection."""
reviewEdge: PullRequestReviewEdge
}
"""Autogenerated input type of AddReaction"""
input AddReactionInput {
"""The Node ID of the subject to modify."""
subjectId: ID!
"""The name of the emoji to react with."""
content: ReactionContent!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddReaction"""
type AddReactionPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The reaction object."""
reaction: Reaction
"""The reactable subject."""
subject: Reactable
}
"""Autogenerated input type of AddStar"""
input AddStarInput {
"""The Starrable ID to star."""
starrableId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddStar"""
type AddStarPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The starrable."""
starrable: Starrable
}
"""A GitHub App."""
type App implements Node {
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
"""The description of the app."""
description: String
id: ID!
"""The hex color code, without the leading '#', for the logo background."""
logoBackgroundColor: String!
"""A URL pointing to the app's logo."""
logoUrl(
"""The size of the resulting image."""
size: Int
): URI!
"""The name of the app."""
name: String!
"""A slug based on the name of the app for use in URLs."""
slug: String!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The URL to the app's homepage."""
url: URI!
}
"""An edge in a connection."""
type AppEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: App
}
"""An object that can have users assigned to it."""
interface Assignable {
"""A list of Users assigned to this object."""
assignees(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): UserConnection!
}
"""Represents an 'assigned' event on any assignable object."""
type AssignedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the assignable associated with the event."""
assignable: Assignable!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""Identifies the user who was assigned."""
user: User
}
"""
Represents a 'base_ref_changed' event on a given issue or pull request.
"""
type BaseRefChangedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
}
"""Represents a 'base_ref_force_pushed' event on a given pull request."""
type BaseRefForcePushedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""
Identifies the after commit SHA for the 'base_ref_force_pushed' event.
"""
afterCommit: Commit
"""
Identifies the before commit SHA for the 'base_ref_force_pushed' event.
"""
beforeCommit: Commit
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""PullRequest referenced by event."""
pullRequest: PullRequest!
"""
Identifies the fully qualified ref name for the 'base_ref_force_pushed' event.
"""
ref: Ref
}
"""Represents a Git blame."""
type Blame {
"""The list of ranges from a Git blame."""
ranges: [BlameRange!]!
}
"""Represents a range of information from a Git blame."""
type BlameRange {
"""
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.
"""
age: Int!
"""Identifies the line author"""
commit: Commit!
"""The ending line for the range"""
endingLine: Int!
"""The starting line for the range"""
startingLine: Int!
}
"""Represents a Git blob."""
type Blob implements Node & GitObject {
"""An abbreviated version of the Git object ID"""
abbreviatedOid: String!
"""Byte size of Blob object"""
byteSize: Int!
"""The HTTP path for this Git object"""
commitResourcePath: URI!
"""The HTTP URL for this Git object"""
commitUrl: URI!
id: ID!
"""Indicates whether the Blob is binary or text"""
isBinary: Boolean!
"""Indicates whether the contents is truncated"""
isTruncated: Boolean!
"""The Git object ID"""
oid: GitObjectID!
"""The Repository the Git object belongs to"""
repository: Repository!
"""UTF8 text data or null if the Blob is binary"""
text: String
}
"""A special type of user which takes actions on behalf of GitHub Apps."""
type Bot implements Node & Actor & UniformResourceLocatable {
"""A URL pointing to the GitHub App's public avatar."""
avatarUrl(
"""The size of the resulting square image."""
size: Int
): URI!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
"""The username of the actor."""
login: String!
"""The HTTP path for this bot"""
resourcePath: URI!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this bot"""
url: URI!
}
"""A branch protection rule."""
type BranchProtectionRule implements Node {
"""
A list of conflicts matching branches protection rule and other branch protection rules
"""
branchProtectionRuleConflicts(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): BranchProtectionRuleConflictConnection!
"""The actor who created this branch protection rule."""
creator: Actor
"""Identifies the primary key from the database."""
databaseId: Int
"""
Will new commits pushed to matching branches dismiss pull request review approvals.
"""
dismissesStaleReviews: Boolean!
id: ID!
"""Can admins overwrite branch protection."""
isAdminEnforced: Boolean!
"""Repository refs that are protected by this rule"""
matchingRefs(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): RefConnection!
"""Identifies the protection rule pattern."""
pattern: String!
"""A list push allowances for this branch protection rule."""
pushAllowances(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): PushAllowanceConnection!
"""The repository associated with this branch protection rule."""
repository: Repository
"""Number of approving reviews required to update matching branches."""
requiredApprovingReviewCount: Int
"""
List of required status check contexts that must pass for commits to be accepted to matching branches.
"""
requiredStatusCheckContexts: [String]
"""Are approving reviews required to update matching branches."""
requiresApprovingReviews: Boolean!
"""Are commits required to be signed."""
requiresCommitSignatures: Boolean!
"""Are status checks required to update matching branches."""
requiresStatusChecks: Boolean!
"""Are branches required to be up to date before merging."""
requiresStrictStatusChecks: Boolean!
"""Is pushing to matching branches restricted."""
restrictsPushes: Boolean!
"""Is dismissal of pull request reviews restricted."""
restrictsReviewDismissals: Boolean!
"""A list review dismissal allowances for this branch protection rule."""
reviewDismissalAllowances(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): ReviewDismissalAllowanceConnection!
}
"""A conflict between two branch protection rules."""
type BranchProtectionRuleConflict {
"""Identifies the branch protection rule."""
branchProtectionRule: BranchProtectionRule
"""Identifies the conflicting branch protection rule."""
conflictingBranchProtectionRule: BranchProtectionRule
"""Identifies the branch ref that has conflicting rules"""
ref: Ref
}
"""The connection type for BranchProtectionRuleConflict."""
type BranchProtectionRuleConflictConnection {
"""A list of edges."""
edges: [BranchProtectionRuleConflictEdge]
"""A list of nodes."""
nodes: [BranchProtectionRuleConflict]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type BranchProtectionRuleConflictEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: BranchProtectionRuleConflict
}
"""The connection type for BranchProtectionRule."""
type BranchProtectionRuleConnection {
"""A list of edges."""
edges: [BranchProtectionRuleEdge]
"""A list of nodes."""
nodes: [BranchProtectionRule]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type BranchProtectionRuleEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: BranchProtectionRule
}
"""An object that can be closed"""
interface Closable {
"""
`true` if the object is closed (definition of closed may depend on type)
"""
closed: Boolean!
"""Identifies the date and time when the object was closed."""
closedAt: DateTime
}
"""Represents a 'closed' event on any `Closable`."""
type ClosedEvent implements Node & UniformResourceLocatable {
"""Identifies the actor who performed the event."""
actor: Actor
"""Object that was closed."""
closable: Closable!
"""Object which triggered the creation of this event."""
closer: Closer
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""The HTTP path for this closed event."""
resourcePath: URI!
"""The HTTP URL for this closed event."""
url: URI!
}
"""The object which triggered a `ClosedEvent`."""
union Closer = Commit | PullRequest
"""The Code of Conduct for a repository"""
type CodeOfConduct {
"""The body of the CoC"""
body: String
"""The key for the CoC"""
key: String!
"""The formal name of the CoC"""
name: String!
"""The path to the CoC"""
url: URI
}
"""Collaborators affiliation level with a subject."""
enum CollaboratorAffiliation {
"""All outside collaborators of an organization-owned subject."""
OUTSIDE
"""
All collaborators with permissions to an organization-owned subject, regardless of organization membership status.
"""
DIRECT
"""All collaborators the authenticated user can see."""
ALL
}
"""Types that can be inside Collection Items."""
union CollectionItemContent = Repository | Organization | User
"""Represents a comment."""
interface Comment {
"""The actor who authored the comment."""
author: Actor
"""Author's association with the subject of the comment."""
authorAssociation: CommentAuthorAssociation!
"""The body as Markdown."""
body: String!
"""The body rendered to HTML."""
bodyHTML: HTML!
"""The body rendered to text."""
bodyText: String!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Check if this comment was created via an email reply."""
createdViaEmail: Boolean!
"""The actor who edited the comment."""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""The moment the editor made the last edit"""
lastEditedAt: DateTime
"""Identifies when the comment was published at."""
publishedAt: DateTime
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""A list of edits to this content."""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): UserContentEditConnection
"""Did the viewer author this comment."""
viewerDidAuthor: Boolean!
}
"""A comment author association with repository."""
enum CommentAuthorAssociation {
"""Author is a member of the organization that owns the repository."""
MEMBER
"""Author is the owner of the repository."""
OWNER
"""Author has been invited to collaborate on the repository."""
COLLABORATOR
"""Author has previously committed to the repository."""
CONTRIBUTOR
"""Author has not previously committed to the repository."""
FIRST_TIME_CONTRIBUTOR
"""Author has not previously committed to GitHub."""
FIRST_TIMER
"""Author has no association with the repository."""
NONE
}
"""The possible errors that will prevent a user from updating a comment."""
enum CommentCannotUpdateReason {
"""
You must be the author or have write access to this repository to update this comment.
"""
INSUFFICIENT_ACCESS
"""Unable to create comment because issue is locked."""
LOCKED
"""You must be logged in to update this comment."""
LOGIN_REQUIRED
"""Repository is under maintenance."""
MAINTENANCE
"""At least one email address must be verified to update this comment."""
VERIFIED_EMAIL_REQUIRED
"""You cannot update this comment"""
DENIED
}
"""
Represents a 'comment_deleted' event on a given issue or pull request.
"""
type CommentDeletedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
}
"""Represents a Git commit."""
type Commit implements Node & GitObject & Subscribable & UniformResourceLocatable {
"""An abbreviated version of the Git object ID"""
abbreviatedOid: String!
"""The number of additions in this commit."""
additions: Int!
"""Authorship details of the commit."""
author: GitActor
"""Check if the committer and the author match."""
authoredByCommitter: Boolean!
"""The datetime when this commit was authored."""
authoredDate: DateTime!
"""Fetches `git blame` information."""
blame(
"""The file whose Git blame information you want."""
path: String!
): Blame!
"""The number of changed files in this commit."""
changedFiles: Int!
"""Comments made on the commit."""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): CommitCommentConnection!
"""The HTTP path for this Git object"""
commitResourcePath: URI!
"""The HTTP URL for this Git object"""
commitUrl: URI!
"""The datetime when this commit was committed."""
committedDate: DateTime!
"""Check if commited via GitHub web UI."""
committedViaWeb: Boolean!
"""Committership details of the commit."""
committer: GitActor
"""The number of deletions in this commit."""
deletions: Int!
"""
The linear commit history starting from (and including) this commit, in the same order as `git log`.
"""
history(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""
If non-null, filters history to only show commits touching files under this path.
"""
path: String
"""
If non-null, filters history to only show commits with matching authorship.
"""
author: CommitAuthor
"""Allows specifying a beginning time or date for fetching commits."""
since: GitTimestamp
"""Allows specifying an ending time or date for fetching commits."""
until: GitTimestamp
): CommitHistoryConnection!
id: ID!
"""The Git commit message"""
message: String!
"""The Git commit message body"""
messageBody: String!
"""The commit message body rendered to HTML."""
messageBodyHTML: HTML!
"""The Git commit message headline"""
messageHeadline: String!
"""The commit message headline rendered to HTML."""
messageHeadlineHTML: HTML!
"""The Git object ID"""
oid: GitObjectID!
"""The parents of a commit."""
parents(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): CommitConnection!
"""The datetime when this commit was pushed."""
pushedDate: DateTime
"""The Repository this commit belongs to"""
repository: Repository!
"""The HTTP path for this commit"""
resourcePath: URI!
"""Commit signing information, if present."""
signature: GitSignature
"""Status information for this commit"""
status: Status
"""
Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
"""
tarballUrl: URI!
"""Commit's root Tree"""
tree: Tree!
"""The HTTP path for the tree of this commit"""
treeResourcePath: URI!
"""The HTTP URL for the tree of this commit"""
treeUrl: URI!
"""The HTTP URL for this commit"""
url: URI!
"""
Check if the viewer is able to change their subscription status for the repository.
"""
viewerCanSubscribe: Boolean!
"""
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
viewerSubscription: SubscriptionState
"""
Returns a URL to download a zipball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
"""
zipballUrl: URI!
}
"""Specifies an author for filtering Git commits."""
input CommitAuthor {
"""
ID of a User to filter by. If non-null, only commits authored by this user
will be returned. This field takes precedence over emails.
"""
id: ID
"""
Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.
"""
emails: [String!]
}
"""Represents a comment on a given Commit."""
type CommitComment implements Node & Comment & Deletable & Updatable & UpdatableComment & Reactable & RepositoryNode {
"""The actor who authored the comment."""
author: Actor
"""Author's association with the subject of the comment."""
authorAssociation: CommentAuthorAssociation!
"""Identifies the comment body."""
body: String!
"""Identifies the comment body rendered to HTML."""
bodyHTML: HTML!
"""The body rendered to text."""
bodyText: String!
"""
Identifies the commit associated with the comment, if the commit exists.
"""
commit: Commit
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Check if this comment was created via an email reply."""
createdViaEmail: Boolean!
"""Identifies the primary key from the database."""
databaseId: Int
"""The actor who edited the comment."""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""Returns whether or not a comment has been minimized."""
isMinimized: Boolean!
"""The moment the editor made the last edit"""
lastEditedAt: DateTime
"""Returns why the comment was minimized."""
minimizedReason: String
"""Identifies the file path associated with the comment."""
path: String
"""Identifies the line position associated with the comment."""
position: Int
"""Identifies when the comment was published at."""
publishedAt: DateTime
"""A list of reactions grouped by content left on the subject."""
reactionGroups: [ReactionGroup!]
"""A list of Reactions left on the Issue."""
reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""Allows filtering Reactions by emoji."""
content: ReactionContent
"""Allows specifying the order in which reactions are returned."""
orderBy: ReactionOrder
): ReactionConnection!
"""The repository associated with this node."""
repository: Repository!
"""The HTTP path permalink for this commit comment."""
resourcePath: URI!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL permalink for this commit comment."""
url: URI!
"""A list of edits to this content."""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): UserContentEditConnection
"""Check if the current viewer can delete this object."""
viewerCanDelete: Boolean!
"""Check if the current viewer can minimize this object."""
viewerCanMinimize: Boolean!
"""Can user react to this subject"""
viewerCanReact: Boolean!
"""Check if the current viewer can update this object."""
viewerCanUpdate: Boolean!
"""Reasons why the current viewer can not update this comment."""
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""Did the viewer author this comment."""
viewerDidAuthor: Boolean!
}
"""The connection type for CommitComment."""
type CommitCommentConnection {
"""A list of edges."""
edges: [CommitCommentEdge]
"""A list of nodes."""
nodes: [CommitComment]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type CommitCommentEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: CommitComment
}
"""A thread of comments on a commit."""
type CommitCommentThread implements Node & RepositoryNode {
"""The comments that exist in this thread."""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): CommitCommentConnection!
"""The commit the comments were made on."""
commit: Commit!
id: ID!
"""The file the comments were made on."""
path: String
"""The position in the diff for the commit that the comment was made on."""
position: Int
"""The repository associated with this node."""
repository: Repository!
}
"""The connection type for Commit."""
type CommitConnection {
"""A list of edges."""
edges: [CommitEdge]
"""A list of nodes."""
nodes: [Commit]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type CommitEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Commit
}
"""The connection type for Commit."""
type CommitHistoryConnection {
"""A list of edges."""
edges: [CommitEdge]
"""A list of nodes."""
nodes: [Commit]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""A content attachment"""
type ContentAttachment {
"""
The body text of the content attachment. This parameter supports markdown.
"""
body: String!
"""The content reference that the content attachment is attached to."""
contentReference: ContentReference!
"""Identifies the primary key from the database."""
databaseId: Int!
id: ID!
"""The title of the content attachment."""
title: String!
}
"""A content reference"""
type ContentReference {
"""Identifies the primary key from the database."""
databaseId: Int!
id: ID!
"""The reference of the content reference."""
reference: String!
}
"""
Represents a contribution a user made on GitHub, such as opening an issue.
"""
interface Contribution {
"""
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.
"""
isRestricted: Boolean!
"""When this contribution was made."""
occurredAt: DateTime!
"""The HTTP path for this contribution."""
resourcePath: URI!
"""The HTTP URL for this contribution."""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""A calendar of contributions made on GitHub by a user."""
type ContributionCalendar {
"""
A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.
"""
colors: [String!]!
"""
Determine if the color set was chosen because it's currently Halloween.
"""
isHalloween: Boolean!
"""A list of the months of contributions in this calendar."""
months: [ContributionCalendarMonth!]!
"""The count of total contributions in the calendar."""
totalContributions: Int!
"""A list of the weeks of contributions in this calendar."""
weeks: [ContributionCalendarWeek!]!
}
"""Represents a single day of contributions on GitHub by a user."""
type ContributionCalendarDay {
"""
The hex color code that represents how many contributions were made on this day compared to others in the calendar.
"""
color: String!
"""How many contributions were made by the user on this day."""
contributionCount: Int!
"""The day this square represents."""
date: Date!
"""
A number representing which day of the week this square represents, e.g., 1 is Monday.
"""
weekday: Int!
}
"""A month of contributions in a user's contribution graph."""
type ContributionCalendarMonth {
"""The date of the first day of this month."""
firstDay: Date!
"""The name of the month."""
name: String!
"""How many weeks started in this month."""
totalWeeks: Int!
"""The year the month occurred in."""
year: Int!
}
"""A week of contributions in a user's contribution graph."""
type ContributionCalendarWeek {
"""The days of contributions in this week."""
contributionDays: [ContributionCalendarDay!]!
"""The date of the earliest square in this week."""
firstDay: Date!
}
"""
A contributions collection aggregates contributions such as opened issues and commits created by a user.
"""
type ContributionsCollection {
"""A calendar of this user's contributions on GitHub."""
contributionCalendar: ContributionCalendar!
"""
Determine if this collection's time span ends in the current month.
"""
doesEndInCurrentMonth: Boolean!
"""
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.
"""
earliestRestrictedContributionDate: Date
"""The ending date and time of this collection."""
endedAt: DateTime!
"""
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.
"""
firstIssueContribution(
"""
If true, the first issue will be returned even if it was opened outside of the collection's time range.
"""
ignoreTimeRange: Boolean = false
): CreatedIssueOrRestrictedContribution
"""
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.
"""
firstPullRequestContribution(
"""
If true, the first pull request will be returned even if it was opened outside of the collection's time range.
"""
ignoreTimeRange: Boolean = false
): CreatedPullRequestOrRestrictedContribution
"""
Does the user have any more activity in the timeline that occurred prior to the collection's time range?
"""
hasActivityInThePast: Boolean!
"""Determine if there are any contributions in this collection."""
hasAnyContributions: 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.
"""
hasAnyRestrictedContributions: Boolean!
"""Whether or not the collector's time span is all within the same day."""
isSingleDay: Boolean!
"""A list of issues the user opened."""
issueContributions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""Should the user's first issue ever be excluded from the result."""
excludeFirst: Boolean = false
"""Should the user's most commented issue be excluded from the result."""
excludePopular: Boolean = false
): CreatedIssueContributionConnection!
"""
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.
"""
joinedGitHubContribution(
"""
If true, the contribution will be returned even if the user signed up outside of the collection's time range.
"""
ignoreTimeRange: Boolean = false
): JoinedGitHubContribution
"""
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.
"""
latestRestrictedContributionDate: Date
"""
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.
"""
mostRecentCollectionWithActivity: ContributionsCollection
"""
Returns a different contributions collection from an earlier time range than this one
that does not have any contributions.
"""
mostRecentCollectionWithoutActivity: ContributionsCollection
"""
The issue the user opened on GitHub that received the most comments in the specified
time frame.
"""
popularIssueContribution: CreatedIssueContribution
"""
The pull request the user opened on GitHub that received the most comments in the
specified time frame.
"""
popularPullRequestContribution: CreatedPullRequestContribution
"""
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.
"""
restrictedContributionsCount: Int!
"""The beginning date and time of this collection."""
startedAt: DateTime!
"""How many commits were made by the user in this time span."""
totalCommitContributions: Int!
"""How many issues the user opened."""
totalIssueContributions(
"""Should the user's first issue ever be excluded from this count."""
excludeFirst: Boolean = false
"""Should the user's most commented issue be excluded from this count."""
excludePopular: Boolean = false
): Int!
"""How many pull requests the user opened."""
totalPullRequestContributions(
"""
Should the user's first pull request ever be excluded from this count.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented pull request be excluded from this count.
"""
excludePopular: Boolean = false
): Int!
"""How many pull request reviews the user left."""
totalPullRequestReviewContributions: Int!
"""How many different repositories the user committed to."""
totalRepositoriesWithContributedCommits: Int!
"""How many different repositories the user opened issues in."""
totalRepositoriesWithContributedIssues(
"""Should the user's first issue ever be excluded from this count."""
excludeFirst: Boolean = false
"""Should the user's most commented issue be excluded from this count."""
excludePopular: Boolean = false
): Int!
"""
How many different repositories the user left pull request reviews in.
"""
totalRepositoriesWithContributedPullRequestReviews: Int!
"""How many different repositories the user opened pull requests in."""
totalRepositoriesWithContributedPullRequests(
"""
Should the user's first pull request ever be excluded from this count.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented pull request be excluded from this count.
"""
excludePopular: Boolean = false
): Int!
"""How many repositories the user created."""
totalRepositoryContributions(
"""Should the user's first repository ever be excluded from this count."""
excludeFirst: Boolean = false
): Int!
"""The user who made the contributions in this collection."""
user: User!
}
"""
Represents a 'converted_note_to_issue' event on a given issue or pull request.
"""
type ConvertedNoteToIssueEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
}
"""Autogenerated input type of CreateBranchProtectionRule"""
input CreateBranchProtectionRuleInput {
"""
The global relay id of the repository in which a new branch protection rule should be created in.
"""
repositoryId: ID!
"""The glob-like pattern used to determine matching branches."""
pattern: String!
"""Are approving reviews required to update matching branches."""
requiresApprovingReviews: Boolean
"""Number of approving reviews required to update matching branches."""
requiredApprovingReviewCount: Int
"""Are commits required to be signed."""
requiresCommitSignatures: Boolean
"""Can admins overwrite branch protection."""
isAdminEnforced: Boolean
"""Are status checks required to update matching branches."""
requiresStatusChecks: Boolean
"""Are branches required to be up to date before merging."""
requiresStrictStatusChecks: Boolean
"""Are reviews from code owners required to update matching branches."""
requiresCodeOwnerReviews: Boolean
"""
Will new commits pushed to matching branches dismiss pull request review approvals.
"""
dismissesStaleReviews: Boolean
"""Is dismissal of pull request reviews restricted."""
restrictsReviewDismissals: Boolean
"""
A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.
"""
reviewDismissalActorIds: [ID!]
"""Is pushing to matching branches restricted."""
restrictsPushes: Boolean
"""A list of User or Team IDs allowed to push to matching branches."""
pushActorIds: [ID!]
"""
List of required status check contexts that must pass for commits to be accepted to matching branches.
"""
requiredStatusCheckContexts: [String!]
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of CreateBranchProtectionRule"""
type CreateBranchProtectionRulePayload {
"""The newly created BranchProtectionRule."""
branchProtectionRule: BranchProtectionRule
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated input type of CreateContentAttachment"""
input CreateContentAttachmentInput {
"""The node ID of the content_reference."""
contentReferenceId: ID!
"""The title of the content attachment."""
title: String!
"""The body of the content attachment, which may contain markdown."""
body: String!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""
Represents the contribution a user made on GitHub by opening an issue.
"""
type CreatedIssueContribution implements Contribution {
"""
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.
"""
isRestricted: Boolean!
"""The issue that was opened."""
issue: Issue!
"""When this contribution was made."""
occurredAt: DateTime!
"""The HTTP path for this contribution."""
resourcePath: URI!
"""The HTTP URL for this contribution."""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""The connection type for CreatedIssueContribution."""
type CreatedIssueContributionConnection {
"""A list of edges."""
edges: [CreatedIssueContributionEdge]
"""A list of nodes."""
nodes: [CreatedIssueContribution]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type CreatedIssueContributionEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: CreatedIssueContribution
}
"""
Represents either a issue the viewer can access or a restricted contribution.
"""
union CreatedIssueOrRestrictedContribution = CreatedIssueContribution | RestrictedContribution
"""
Represents the contribution a user made on GitHub by opening a pull request.
"""
type CreatedPullRequestContribution implements Contribution {
"""
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.
"""
isRestricted: Boolean!
"""When this contribution was made."""
occurredAt: DateTime!
"""The pull request that was opened."""
pullRequest: PullRequest!
"""The HTTP path for this contribution."""
resourcePath: URI!
"""The HTTP URL for this contribution."""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""The connection type for CreatedPullRequestContribution."""
type CreatedPullRequestContributionConnection {
"""A list of edges."""
edges: [CreatedPullRequestContributionEdge]
"""A list of nodes."""
nodes: [CreatedPullRequestContribution]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type CreatedPullRequestContributionEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: CreatedPullRequestContribution
}
"""
Represents either a pull request the viewer can access or a restricted contribution.
"""
union CreatedPullRequestOrRestrictedContribution = CreatedPullRequestContribution | RestrictedContribution
"""Autogenerated input type of CreateProject"""
input CreateProjectInput {
"""The owner ID to create the project under."""
ownerId: ID!
"""The name of project."""
name: String!
"""The description of project."""
body: String
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of CreateProject"""
type CreateProjectPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The new project."""
project: Project
}
"""Represents a mention made by one issue or pull request to another."""
type CrossReferencedEvent implements Node & UniformResourceLocatable {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""Reference originated in a different repository."""
isCrossRepository: Boolean!
"""Identifies when the reference was made."""
referencedAt: DateTime!
"""The HTTP path for this pull request."""
resourcePath: URI!
"""Issue or pull request that made the reference."""
source: ReferencedSubject!
"""Issue or pull request to which the reference was made."""
target: ReferencedSubject!
"""The HTTP URL for this pull request."""
url: URI!
"""Checks if the target will be closed when the source is merged."""
willCloseTarget: Boolean!
}
"""An ISO-8601 encoded date string."""
scalar Date
"""An ISO-8601 encoded UTC date string."""
scalar DateTime
"""Autogenerated input type of DeclineTopicSuggestion"""
input DeclineTopicSuggestionInput {
"""The Node ID of the repository."""
repositoryId: ID!
"""The name of the suggested topic."""
name: String!
"""The reason why the suggested topic is declined."""
reason: TopicSuggestionDeclineReason!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of DeclineTopicSuggestion"""
type DeclineTopicSuggestionPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The declined topic."""
topic: Topic
}
"""The possible default permissions for repositories."""
enum DefaultRepositoryPermissionField {
"""No access"""
NONE
"""Can read repos by default"""
READ
"""Can read and write repos by default"""
WRITE
"""Can read, write, and administrate repos by default"""
ADMIN
}
"""Entities that can be deleted."""
interface Deletable {
"""Check if the current viewer can delete this object."""
viewerCanDelete: Boolean!
}
"""Autogenerated input type of DeleteBranchProtectionRule"""
input DeleteBranchProtectionRuleInput {
"""The global relay id of the branch protection rule to be deleted."""
branchProtectionRuleId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of DeleteBranchProtectionRule"""
type DeleteBranchProtectionRulePayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated input type of DeleteIssue"""
input DeleteIssueInput {
"""The ID of the issue to delete."""
issueId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated input type of DeleteProjectCard"""
input DeleteProjectCardInput {
"""The id of the card to delete."""
cardId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of DeleteProjectCard"""
type DeleteProjectCardPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The column the deleted card was in."""
column: ProjectColumn
"""The deleted card ID."""
deletedCardId: ID
}
"""Autogenerated input type of DeleteProjectColumn"""
input DeleteProjectColumnInput {
"""The id of the column to delete."""
columnId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of DeleteProjectColumn"""
type DeleteProjectColumnPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The deleted column ID."""
deletedColumnId: ID
"""The project the deleted column was in."""
project: Project
}
"""Autogenerated input type of DeleteProject"""
input DeleteProjectInput {
"""The Project ID to update."""
projectId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of DeleteProject"""
type DeleteProjectPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The repository or organization the project was removed from."""
owner: ProjectOwner
}
"""Autogenerated input type of DeletePullRequestReview"""
input DeletePullRequestReviewInput {
"""The Node ID of the pull request review to delete."""
pullRequestReviewId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of DeletePullRequestReview"""
type DeletePullRequestReviewPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The deleted pull request review."""
pullRequestReview: PullRequestReview
}
"""Represents a 'demilestoned' event on a given issue or pull request."""
type DemilestonedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""
Identifies the milestone title associated with the 'demilestoned' event.
"""
milestoneTitle: String!
"""Object referenced by event."""
subject: MilestoneItem!
}
"""Represents a 'deployed' event on a given pull request."""
type DeployedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
"""The deployment associated with the 'deployed' event."""
deployment: Deployment!
id: ID!
"""PullRequest referenced by event."""
pullRequest: PullRequest!
"""The ref associated with the 'deployed' event."""
ref: Ref
}
"""A repository deploy key."""
type DeployKey implements Node {
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""The deploy key."""
key: String!
"""Whether or not the deploy key is read only."""
readOnly: Boolean!
"""The deploy key title."""
title: String!
"""Whether or not the deploy key has been verified."""
verified: Boolean!
}
"""The connection type for DeployKey."""
type DeployKeyConnection {
"""A list of edges."""
edges: [DeployKeyEdge]
"""A list of nodes."""
nodes: [DeployKey]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type DeployKeyEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: DeployKey
}
"""Represents triggered deployment instance."""
type Deployment implements Node {
"""Identifies the commit sha of the deployment."""
commit: Commit
"""
Identifies the oid of the deployment commit, even if the commit has been deleted.
"""
commitOid: String!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the actor who triggered the deployment."""
creator: Actor
"""Identifies the primary key from the database."""
databaseId: Int
"""The deployment description."""
description: String
"""The environment to which this deployment was made."""
environment: String
id: ID!
"""The latest status of this deployment."""
latestStatus: DeploymentStatus
"""Extra information that a deployment system might need."""
payload: String
"""
Identifies the Ref of the deployment, if the deployment was created by ref.
"""
ref: Ref
"""Identifies the repository associated with the deployment."""
repository: Repository!
"""The current state of the deployment."""
state: DeploymentState
"""A list of statuses associated with the deployment."""
statuses(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): DeploymentStatusConnection
"""The deployment task."""
task: String
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
}
"""The connection type for Deployment."""
type DeploymentConnection {
"""A list of edges."""
edges: [DeploymentEdge]
"""A list of nodes."""
nodes: [Deployment]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type DeploymentEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Deployment
}
"""
Represents a 'deployment_environment_changed' event on a given pull request.
"""
type DeploymentEnvironmentChangedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""The deployment status that updated the deployment environment."""
deploymentStatus: DeploymentStatus!
id: ID!
"""PullRequest referenced by event."""
pullRequest: PullRequest!
}
"""The possible states in which a deployment can be."""
enum DeploymentState {
"""The pending deployment was not updated after 30 minutes."""
ABANDONED
"""The deployment is currently active."""
ACTIVE
"""An inactive transient deployment."""
DESTROYED
"""The deployment experienced an error."""
ERROR
"""The deployment has failed."""
FAILURE
"""The deployment is inactive."""
INACTIVE
"""The deployment is pending."""
PENDING
}
"""Describes the status of a given deployment attempt."""
type DeploymentStatus implements Node {
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the actor who triggered the deployment."""
creator: Actor
"""Identifies the deployment associated with status."""
deployment: Deployment!
"""Identifies the description of the deployment."""
description: String
"""Identifies the environment URL of the deployment."""
environmentUrl: URI
id: ID!
"""Identifies the log URL of the deployment."""
logUrl: URI
"""Identifies the current state of the deployment."""
state: DeploymentStatusState!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
}
"""The connection type for DeploymentStatus."""
type DeploymentStatusConnection {
"""A list of edges."""
edges: [DeploymentStatusEdge]
"""A list of nodes."""
nodes: [DeploymentStatus]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type DeploymentStatusEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: DeploymentStatus
}
"""The possible states for a deployment status."""
enum DeploymentStatusState {
"""The deployment is pending."""
PENDING
"""The deployment was successful."""
SUCCESS
"""The deployment has failed."""
FAILURE
"""The deployment is inactive."""
INACTIVE
"""The deployment experienced an error."""
ERROR
}
"""Autogenerated input type of DismissPullRequestReview"""
input DismissPullRequestReviewInput {
"""The Node ID of the pull request review to modify."""
pullRequestReviewId: ID!
"""The contents of the pull request review dismissal message."""
message: String!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of DismissPullRequestReview"""
type DismissPullRequestReviewPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The dismissed pull request review."""
pullRequestReview: PullRequestReview
}
"""Specifies a review comment to be left with a Pull Request Review."""
input DraftPullRequestReviewComment {
"""Path to the file being commented on."""
path: String!
"""Position in the file to leave a comment on."""
position: Int!
"""Body of the comment to leave."""
body: String!
}
"""An external identity provisioned by SAML SSO or SCIM."""
type ExternalIdentity implements Node {
"""The GUID for this identity"""
guid: String!
id: ID!
"""Organization invitation for this SCIM-provisioned external identity"""
organizationInvitation: OrganizationInvitation
"""SAML Identity attributes"""
samlIdentity: ExternalIdentitySamlAttributes
"""SCIM Identity attributes"""
scimIdentity: ExternalIdentityScimAttributes
"""
User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.
"""
user: User
}
"""The connection type for ExternalIdentity."""
type ExternalIdentityConnection {
"""A list of edges."""
edges: [ExternalIdentityEdge]
"""A list of nodes."""
nodes: [ExternalIdentity]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type ExternalIdentityEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: ExternalIdentity
}
"""SAML attributes for the External Identity"""
type ExternalIdentitySamlAttributes {
"""The NameID of the SAML identity"""
nameId: String
}
"""SCIM attributes for the External Identity"""
type ExternalIdentityScimAttributes {
"""The userName of the SCIM identity"""
username: String
}
"""The connection type for User."""
type FollowerConnection {
"""A list of edges."""
edges: [UserEdge]
"""A list of nodes."""
nodes: [User]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""The connection type for User."""
type FollowingConnection {
"""A list of edges."""
edges: [UserEdge]
"""A list of nodes."""
nodes: [User]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""A Gist."""
type Gist implements Node & Starrable {
"""A list of comments associated with the gist"""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): GistCommentConnection!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""The gist description."""
description: String
id: ID!
"""Whether the gist is public or not."""
isPublic: Boolean!
"""The gist name."""
name: String!
"""The gist owner."""
owner: RepositoryOwner
"""Identifies when the gist was last pushed to."""
pushedAt: DateTime
"""A list of users who have starred this starrable."""
stargazers(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""Order for connection"""
orderBy: StarOrder
): StargazerConnection!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""
Returns a boolean indicating whether the viewing user has starred this starrable.
"""
viewerHasStarred: Boolean!
}
"""Represents a comment on an Gist."""
type GistComment implements Node & Comment & Deletable & Updatable & UpdatableComment {
"""The actor who authored the comment."""
author: Actor
"""Author's association with the gist."""
authorAssociation: CommentAuthorAssociation!
"""Identifies the comment body."""
body: String!
"""The comment body rendered to HTML."""
bodyHTML: HTML!
"""The body rendered to text."""
bodyText: String!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Check if this comment was created via an email reply."""
createdViaEmail: Boolean!
"""Identifies the primary key from the database."""
databaseId: Int
"""The actor who edited the comment."""
editor: Actor
"""The associated gist."""
gist: Gist!
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""Returns whether or not a comment has been minimized."""
isMinimized: Boolean!
"""The moment the editor made the last edit"""
lastEditedAt: DateTime
"""Returns why the comment was minimized."""
minimizedReason: String
"""Identifies when the comment was published at."""
publishedAt: DateTime
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""A list of edits to this content."""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): UserContentEditConnection
"""Check if the current viewer can delete this object."""
viewerCanDelete: Boolean!
"""Check if the current viewer can minimize this object."""
viewerCanMinimize: Boolean!
"""Check if the current viewer can update this object."""
viewerCanUpdate: Boolean!
"""Reasons why the current viewer can not update this comment."""
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""Did the viewer author this comment."""
viewerDidAuthor: Boolean!
}
"""The connection type for GistComment."""
type GistCommentConnection {
"""A list of edges."""
edges: [GistCommentEdge]
"""A list of nodes."""
nodes: [GistComment]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type GistCommentEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: GistComment
}
"""The connection type for Gist."""
type GistConnection {
"""A list of edges."""
edges: [GistEdge]
"""A list of nodes."""
nodes: [Gist]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type GistEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Gist
}
"""Ordering options for gist connections"""
input GistOrder {
"""The field to order repositories by."""
field: GistOrderField!
"""The ordering direction."""
direction: OrderDirection!
}
"""Properties by which gist connections can be ordered."""
enum GistOrderField {
"""Order gists by creation time"""
CREATED_AT
"""Order gists by update time"""
UPDATED_AT
"""Order gists by push time"""
PUSHED_AT
}
"""The privacy of a Gist"""
enum GistPrivacy {
"""Public"""
PUBLIC
"""Secret"""
SECRET
"""Gists that are public and secret"""
ALL
}
"""Represents an actor in a Git commit (ie. an author or committer)."""
type GitActor {
"""A URL pointing to the author's public avatar."""
avatarUrl(
"""The size of the resulting square image."""
size: Int
): URI!
"""The timestamp of the Git action (authoring or committing)."""
date: GitTimestamp
"""The email in the Git commit."""
email: String
"""The name in the Git commit."""
name: String
"""
The GitHub user corresponding to the email field. Null if no such user exists.
"""
user: User
}
"""Represents information about the GitHub instance."""
type GitHubMetadata {
"""Returns a String that's a SHA of `github-services`"""
gitHubServicesSha: GitObjectID!
"""IP addresses that users connect to for git operations"""
gitIpAddresses: [String!]
"""IP addresses that service hooks are sent from"""
hookIpAddresses: [String!]
"""IP addresses that the importer connects from"""
importerIpAddresses: [String!]
"""Whether or not users are verified"""
isPasswordAuthenticationVerifiable: Boolean!
"""IP addresses for GitHub Pages' A records"""
pagesIpAddresses: [String!]
}
"""Represents a Git object."""
interface GitObject {
"""An abbreviated version of the Git object ID"""
abbreviatedOid: String!
"""The HTTP path for this Git object"""
commitResourcePath: URI!
"""The HTTP URL for this Git object"""
commitUrl: URI!
id: ID!
"""The Git object ID"""
oid: GitObjectID!
"""The Repository the Git object belongs to"""
repository: Repository!
}
"""A Git object ID."""
scalar GitObjectID
"""Information about a signature (GPG or S/MIME) on a Commit or Tag."""
interface GitSignature {
"""Email used to sign this object."""
email: String!
"""True if the signature is valid and verified by GitHub."""
isValid: Boolean!
"""
Payload for GPG signing object. Raw ODB object without the signature header.
"""
payload: String!
"""ASCII-armored signature header from object."""
signature: String!
"""GitHub user corresponding to the email signing this commit."""
signer: User
"""
The state of this signature. `VALID` if signature is valid and verified by
GitHub, otherwise represents reason why signature is considered invalid.
"""
state: GitSignatureState!
"""True if the signature was made with GitHub's signing key."""
wasSignedByGitHub: Boolean!
}
"""The state of a Git signature."""
enum GitSignatureState {
"""Valid signature and verified by GitHub"""
VALID
"""Invalid signature"""
INVALID
"""Malformed signature"""
MALFORMED_SIG
"""Key used for signing not known to GitHub"""
UNKNOWN_KEY
"""Invalid email used for signing"""
BAD_EMAIL
"""Email used for signing unverified on GitHub"""
UNVERIFIED_EMAIL
"""Email used for signing not known to GitHub"""
NO_USER
"""Unknown signature type"""
UNKNOWN_SIG_TYPE
"""Unsigned"""
UNSIGNED
"""
Internal error - the GPG verification service is unavailable at the moment
"""
GPGVERIFY_UNAVAILABLE
"""Internal error - the GPG verification service misbehaved"""
GPGVERIFY_ERROR
"""The usage flags for the key that signed this don't allow signing"""
NOT_SIGNING_KEY
"""Signing key expired"""
EXPIRED_KEY
"""Valid signature, pending certificate revocation checking"""
OCSP_PENDING
"""Valid siganture, though certificate revocation check failed"""
OCSP_ERROR
"""The signing certificate or its chain could not be verified"""
BAD_CERT
"""One or more certificates in chain has been revoked"""
OCSP_REVOKED
}
"""Git SSH string"""
scalar GitSSHRemote
"""
An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC.
"""
scalar GitTimestamp
"""Represents a GPG signature on a Commit or Tag."""
type GpgSignature implements GitSignature {
"""Email used to sign this object."""
email: String!
"""True if the signature is valid and verified by GitHub."""
isValid: Boolean!
"""Hex-encoded ID of the key that signed this object."""
keyId: String
"""
Payload for GPG signing object. Raw ODB object without the signature header.
"""
payload: String!
"""ASCII-armored signature header from object."""
signature: String!
"""GitHub user corresponding to the email signing this commit."""
signer: User
"""
The state of this signature. `VALID` if signature is valid and verified by
GitHub, otherwise represents reason why signature is considered invalid.
"""
state: GitSignatureState!
"""True if the signature was made with GitHub's signing key."""
wasSignedByGitHub: Boolean!
}
"""Represents a 'head_ref_deleted' event on a given pull request."""
type HeadRefDeletedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the Ref associated with the `head_ref_deleted` event."""
headRef: Ref
"""
Identifies the name of the Ref associated with the `head_ref_deleted` event.
"""
headRefName: String!
id: ID!
"""PullRequest referenced by event."""
pullRequest: PullRequest!
}
"""Represents a 'head_ref_force_pushed' event on a given pull request."""
type HeadRefForcePushedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""
Identifies the after commit SHA for the 'head_ref_force_pushed' event.
"""
afterCommit: Commit
"""
Identifies the before commit SHA for the 'head_ref_force_pushed' event.
"""
beforeCommit: Commit
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""PullRequest referenced by event."""
pullRequest: PullRequest!
"""
Identifies the fully qualified ref name for the 'head_ref_force_pushed' event.
"""
ref: Ref
}
"""Represents a 'head_ref_restored' event on a given pull request."""
type HeadRefRestoredEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""PullRequest referenced by event."""
pullRequest: PullRequest!
}
"""A string containing HTML code."""
scalar HTML
"""
An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
"""
type Issue implements Node & Assignable & Closable & Comment & Updatable & UpdatableComment & Labelable & Lockable & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable {
"""Reason that the conversation was locked."""
activeLockReason: LockReason
"""A list of Users assigned to this object."""
assignees(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): UserConnection!
"""The actor who authored the comment."""
author: Actor
"""Author's association with the subject of the comment."""
authorAssociation: CommentAuthorAssociation!
"""Identifies the body of the issue."""
body: String!
"""Identifies the body of the issue rendered to HTML."""
bodyHTML: HTML!
"""Identifies the body of the issue rendered to text."""
bodyText: String!
"""
`true` if the object is closed (definition of closed may depend on type)
"""
closed: Boolean!
"""Identifies the date and time when the object was closed."""
closedAt: DateTime
"""A list of comments associated with the Issue."""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): IssueCommentConnection!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Check if this comment was created via an email reply."""
createdViaEmail: Boolean!
"""Identifies the primary key from the database."""
databaseId: Int
"""The actor who edited the comment."""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""A list of labels associated with the object."""
labels(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): LabelConnection
"""The moment the editor made the last edit"""
lastEditedAt: DateTime
"""`true` if the object is locked"""
locked: Boolean!
"""Identifies the milestone associated with the issue."""
milestone: Milestone
"""Identifies the issue number."""
number: Int!
"""A list of Users that are participating in the Issue conversation."""
participants(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): UserConnection!
"""List of project cards associated with this issue."""
projectCards(
"""A list of archived states to filter the cards by"""
archivedStates: [ProjectCardArchivedState]
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): ProjectCardConnection!
"""Identifies when the comment was published at."""
publishedAt: DateTime
"""A list of reactions grouped by content left on the subject."""
reactionGroups: [ReactionGroup!]
"""A list of Reactions left on the Issue."""
reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""Allows filtering Reactions by emoji."""
content: ReactionContent
"""Allows specifying the order in which reactions are returned."""
orderBy: ReactionOrder
): ReactionConnection!
"""The repository associated with this node."""
repository: Repository!
"""The HTTP path for this issue"""
resourcePath: URI!
"""Identifies the state of the issue."""
state: IssueState!
"""A list of events, comments, commits, etc. associated with the issue."""
timeline(
"""Allows filtering timeline events by a `since` timestamp."""
since: DateTime
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): IssueTimelineConnection!
"""Identifies the issue title."""
title: String!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this issue"""
url: URI!
"""A list of edits to this content."""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
): UserContentEditConnection
"""Can user react to this subject"""
viewerCanReact: Boolean!
"""
Check if the viewer is able to change their subscription status for the repository.
"""
viewerCanSubscribe: Boolean!
"""Check if the current viewer can update this object."""
viewerCanUpdate: Boolean!
"""Reasons why the current viewer can not update this comment."""
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""Did the viewer author this comment."""
viewerDidAuthor: Boolean!
"""
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
viewerSubscription: SubscriptionState
}