Skip to content

Instantly share code, notes, and snippets.

@prkagrawal

prkagrawal/github.graphql

Created November 8, 2022 10:18
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save prkagrawal/c964c93ee7750ea9d8baee7c012feccf to your computer and use it in GitHub Desktop.
Save prkagrawal/c964c93ee7750ea9d8baee7c012feccf to your computer and use it in GitHub Desktop.
Download ZIP
Graphql schema for github.com
Raw
github.graphql
"""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
}
"""Represents a comment on an Issue."""
type IssueComment 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!
"""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!
"""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!
"""Identifies the issue associated with the comment."""
issue: Issue!
"""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
"""
Returns the pull request associated with the comment, if this comment was made on a
pull request.
"""
pullRequest: PullRequest
"""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 comment"""
resourcePath: URI!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this issue 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 IssueComment."""
type IssueCommentConnection {
"""A list of edges."""
edges: [IssueCommentEdge]
"""A list of nodes."""
nodes: [IssueComment]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type IssueCommentEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: IssueComment
}
"""The connection type for Issue."""
type IssueConnection {
"""A list of edges."""
edges: [IssueEdge]
"""A list of nodes."""
nodes: [Issue]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type IssueEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Issue
}
"""Ways in which lists of issues can be ordered upon return."""
input IssueOrder {
"""The field in which to order issues by."""
field: IssueOrderField!
"""The direction in which to order issues by the specified field."""
direction: OrderDirection!
}
"""Properties by which issue connections can be ordered."""
enum IssueOrderField {
"""Order issues by creation time"""
CREATED_AT
"""Order issues by update time"""
UPDATED_AT
"""Order issues by comment count"""
COMMENTS
}
"""Used for return value of Repository.issueOrPullRequest."""
union IssueOrPullRequest = Issue | PullRequest
"""The possible PubSub channels for an issue."""
enum IssuePubSubTopic {
"""The channel ID for observing issue updates."""
UPDATED
"""The channel ID for marking an issue as read."""
MARKASREAD
"""The channel ID for updating items on the issue timeline."""
TIMELINE
"""The channel ID for observing issue state updates."""
STATE
}
"""The possible states of an issue."""
enum IssueState {
"""An issue that is still open"""
OPEN
"""An issue that has been closed"""
CLOSED
}
"""The connection type for IssueTimelineItem."""
type IssueTimelineConnection {
"""A list of edges."""
edges: [IssueTimelineItemEdge]
"""A list of nodes."""
nodes: [IssueTimelineItem]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An item in an issue timeline"""
union IssueTimelineItem = Commit | IssueComment | CrossReferencedEvent | ClosedEvent | ReopenedEvent | SubscribedEvent | UnsubscribedEvent | ReferencedEvent | AssignedEvent | UnassignedEvent | LabeledEvent | UnlabeledEvent | MilestonedEvent | DemilestonedEvent | RenamedTitleEvent | LockedEvent | UnlockedEvent | TransferredEvent
"""An edge in a connection."""
type IssueTimelineItemEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: IssueTimelineItem
}
"""An item in an issue timeline"""
union IssueTimelineItems = IssueComment | CrossReferencedEvent | AddedToProjectEvent | AssignedEvent | ClosedEvent | CommentDeletedEvent | ConvertedNoteToIssueEvent | DemilestonedEvent | LabeledEvent | LockedEvent | MentionedEvent | MilestonedEvent | MovedColumnsInProjectEvent | PinnedEvent | ReferencedEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnpinnedEvent | UnsubscribedEvent
"""An edge in a connection."""
type IssueTimelineItemsEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: IssueTimelineItems
}
"""The possible item types found in a timeline."""
enum IssueTimelineItemsItemType {
"""Represents a comment on an Issue."""
ISSUE_COMMENT
"""Represents a mention made by one issue or pull request to another."""
CROSS_REFERENCED_EVENT
"""
Represents a 'added_to_project' event on a given issue or pull request.
"""
ADDED_TO_PROJECT_EVENT
"""Represents an 'assigned' event on any assignable object."""
ASSIGNED_EVENT
"""Represents a 'closed' event on any `Closable`."""
CLOSED_EVENT
"""
Represents a 'comment_deleted' event on a given issue or pull request.
"""
COMMENT_DELETED_EVENT
"""
Represents a 'converted_note_to_issue' event on a given issue or pull request.
"""
CONVERTED_NOTE_TO_ISSUE_EVENT
"""Represents a 'demilestoned' event on a given issue or pull request."""
DEMILESTONED_EVENT
"""Represents a 'labeled' event on a given issue or pull request."""
LABELED_EVENT
"""Represents a 'locked' event on a given issue or pull request."""
LOCKED_EVENT
"""Represents a 'mentioned' event on a given issue or pull request."""
MENTIONED_EVENT
"""Represents a 'milestoned' event on a given issue or pull request."""
MILESTONED_EVENT
"""
Represents a 'moved_columns_in_project' event on a given issue or pull request.
"""
MOVED_COLUMNS_IN_PROJECT_EVENT
"""Represents a 'pinned' event on a given issue or pull request."""
PINNED_EVENT
"""Represents a 'referenced' event on a given `ReferencedSubject`."""
REFERENCED_EVENT
"""
Represents a 'removed_from_project' event on a given issue or pull request.
"""
REMOVED_FROM_PROJECT_EVENT
"""Represents a 'renamed' event on a given issue or pull request"""
RENAMED_TITLE_EVENT
"""Represents a 'reopened' event on any `Closable`."""
REOPENED_EVENT
"""Represents a 'subscribed' event on a given `Subscribable`."""
SUBSCRIBED_EVENT
"""Represents a 'transferred' event on a given issue or pull request."""
TRANSFERRED_EVENT
"""Represents an 'unassigned' event on any assignable object."""
UNASSIGNED_EVENT
"""Represents an 'unlabeled' event on a given issue or pull request."""
UNLABELED_EVENT
"""Represents an 'unlocked' event on a given issue or pull request."""
UNLOCKED_EVENT
"""Represents an 'unpinned' event on a given issue or pull request."""
UNPINNED_EVENT
"""Represents an 'unsubscribed' event on a given `Subscribable`."""
UNSUBSCRIBED_EVENT
}
"""Represents a user signing up for a GitHub account."""
type JoinedGitHubContribution 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 HTTP path for this contribution."""
resourcePath: URI!
"""The HTTP URL for this contribution."""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""
A label for categorizing Issues or Milestones with a given Repository.
"""
type Label implements Node {
"""Identifies the label color."""
color: String!
"""Identifies the date and time when the label was created."""
createdAt: DateTime
"""A brief description of this label."""
description: String
id: ID!
"""Indicates whether or not this is a default label."""
isDefault: Boolean!
"""A list of issues associated with this label."""
issues(
"""Ordering options for issues returned from the connection."""
orderBy: IssueOrder
"""A list of label names to filter the pull requests by."""
labels: [String!]
"""A list of states to filter the issues by."""
states: [IssueState!]
"""
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
): IssueConnection!
"""Identifies the label name."""
name: String!
"""A list of pull requests associated with this label."""
pullRequests(
"""A list of states to filter the pull requests by."""
states: [PullRequestState!]
"""A list of label names to filter the pull requests by."""
labels: [String!]
"""The head ref name to filter the pull requests by."""
headRefName: String
"""The base ref name to filter the pull requests by."""
baseRefName: String
"""Ordering options for pull requests returned from the connection."""
orderBy: IssueOrder
"""
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
): PullRequestConnection!
"""The repository associated with this label."""
repository: Repository!
"""The HTTP path for this label."""
resourcePath: URI!
"""Identifies the date and time when the label was last updated."""
updatedAt: DateTime
"""The HTTP URL for this label."""
url: URI!
}
"""An object that can have labels assigned to it."""
interface Labelable {
"""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 connection type for Label."""
type LabelConnection {
"""A list of edges."""
edges: [LabelEdge]
"""A list of nodes."""
nodes: [Label]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""Represents a 'labeled' event on a given issue or pull request."""
type LabeledEvent 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 label associated with the 'labeled' event."""
label: Label!
"""Identifies the `Labelable` associated with the event."""
labelable: Labelable!
}
"""An edge in a connection."""
type LabelEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Label
}
"""Represents a given language found in repositories."""
type Language implements Node {
"""The color defined for the current language."""
color: String
id: ID!
"""The name of the current language."""
name: String!
}
"""A list of languages associated with the parent."""
type LanguageConnection {
"""A list of edges."""
edges: [LanguageEdge]
"""A list of nodes."""
nodes: [Language]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
"""The total size in bytes of files written in that language."""
totalSize: Int!
}
"""Represents the language of a repository."""
type LanguageEdge {
cursor: String!
node: Language!
"""The number of bytes of code written in the language."""
size: Int!
}
"""Ordering options for language connections."""
input LanguageOrder {
"""The field to order languages by."""
field: LanguageOrderField!
"""The ordering direction."""
direction: OrderDirection!
}
"""Properties by which language connections can be ordered."""
enum LanguageOrderField {
"""Order languages by the size of all files containing the language"""
SIZE
}
"""A repository's open source license"""
type License implements Node {
"""The full text of the license"""
body: String!
"""The conditions set by the license"""
conditions: [LicenseRule]!
"""A human-readable description of the license"""
description: String
"""Whether the license should be featured"""
featured: Boolean!
"""Whether the license should be displayed in license pickers"""
hidden: Boolean!
id: ID!
"""Instructions on how to implement the license"""
implementation: String
"""The lowercased SPDX ID of the license"""
key: String!
"""The limitations set by the license"""
limitations: [LicenseRule]!
"""The license full name specified by <https://spdx.org/licenses>"""
name: String!
"""Customary short name if applicable (e.g, GPLv3)"""
nickname: String
"""The permissions set by the license"""
permissions: [LicenseRule]!
"""
Whether the license is a pseudo-license placeholder (e.g., other, no-license)
"""
pseudoLicense: Boolean!
"""Short identifier specified by <https://spdx.org/licenses>"""
spdxId: String
"""URL to the license on <https://choosealicense.com>"""
url: URI
}
"""Describes a License's conditions, permissions, and limitations"""
type LicenseRule {
"""A description of the rule"""
description: String!
"""The machine-readable rule key"""
key: String!
"""The human-readable rule label"""
label: String!
}
"""An object that can be locked."""
interface Lockable {
"""Reason that the conversation was locked."""
activeLockReason: LockReason
"""`true` if the object is locked"""
locked: Boolean!
}
"""Represents a 'locked' event on a given issue or pull request."""
type LockedEvent 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!
"""Reason that the conversation was locked (optional)."""
lockReason: LockReason
"""Object that was locked."""
lockable: Lockable!
}
"""Autogenerated input type of LockLockable"""
input LockLockableInput {
"""ID of the issue or pull request to be locked."""
lockableId: ID!
"""A reason for why the issue or pull request will be locked."""
lockReason: LockReason
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of LockLockable"""
type LockLockablePayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The item that was locked."""
lockedRecord: Lockable
}
"""The possible reasons that an issue or pull request was locked."""
enum LockReason {
"""
The issue or pull request was locked because the conversation was off-topic.
"""
OFF_TOPIC
"""
The issue or pull request was locked because the conversation was too heated.
"""
TOO_HEATED
"""
The issue or pull request was locked because the conversation was resolved.
"""
RESOLVED
"""
The issue or pull request was locked because the conversation was spam.
"""
SPAM
}
"""A public description of a Marketplace category."""
type MarketplaceCategory implements Node {
"""The category's description."""
description: String
"""
The technical description of how apps listed in this category work with GitHub.
"""
howItWorks: String
id: ID!
"""The category's name."""
name: String!
"""How many Marketplace listings have this as their primary category."""
primaryListingCount: Int!
"""The HTTP path for this Marketplace category."""
resourcePath: URI!
"""How many Marketplace listings have this as their secondary category."""
secondaryListingCount: Int!
"""The short name of the category used in its URL."""
slug: String!
"""The HTTP URL for this Marketplace category."""
url: URI!
}
"""A listing in the GitHub integration marketplace."""
type MarketplaceListing implements Node {
"""The GitHub App this listing represents."""
app: App
"""URL to the listing owner's company site."""
companyUrl: URI
"""
The HTTP path for configuring access to the listing's integration or OAuth app
"""
configurationResourcePath: URI!
"""
The HTTP URL for configuring access to the listing's integration or OAuth app
"""
configurationUrl: URI!
"""URL to the listing's documentation."""
documentationUrl: URI
"""The listing's detailed description."""
extendedDescription: String
"""The listing's detailed description rendered to HTML."""
extendedDescriptionHTML: HTML!
"""The listing's introductory description."""
fullDescription: String!
"""The listing's introductory description rendered to HTML."""
fullDescriptionHTML: HTML!
"""
Whether this listing has been submitted for review from GitHub for approval to be displayed in the Marketplace.
"""
hasApprovalBeenRequested: Boolean!
"""Does this listing have any plans with a free trial?"""
hasPublishedFreeTrialPlans: Boolean!
"""Does this listing have a terms of service link?"""
hasTermsOfService: Boolean!
"""A technical description of how this app works with GitHub."""
howItWorks: String
"""The listing's technical description rendered to HTML."""
howItWorksHTML: HTML!
id: ID!
"""URL to install the product to the viewer's account or organization."""
installationUrl: URI
"""Whether this listing's app has been installed for the current viewer"""
installedForViewer: Boolean!
"""
Whether this listing has been approved for display in the Marketplace.
"""
isApproved: Boolean!
"""Whether this listing has been removed from the Marketplace."""
isDelisted: Boolean!
"""
Whether this listing is still an editable draft that has not been submitted
for review and is not publicly visible in the Marketplace.
"""
isDraft: Boolean!
"""
Whether the product this listing represents is available as part of a paid plan.
"""
isPaid: Boolean!
"""
Whether this listing has been rejected by GitHub for display in the Marketplace.
"""
isRejected: Boolean!
"""The hex color code, without the leading '#', for the logo background."""
logoBackgroundColor: String!
"""URL for the listing's logo image."""
logoUrl(
"""The size in pixels of the resulting square image."""
size: Int = 400
): URI
"""The listing's full name."""
name: String!
"""
The listing's very short description without a trailing period or ampersands.
"""
normalizedShortDescription: String!
"""URL to the listing's detailed pricing."""
pricingUrl: URI
"""The category that best describes the listing."""
primaryCategory: MarketplaceCategory!
"""URL to the listing's privacy policy."""
privacyPolicyUrl: URI!
"""The HTTP path for the Marketplace listing."""
resourcePath: URI!
"""The URLs for the listing's screenshots."""
screenshotUrls: [String]!
"""An alternate category that describes the listing."""
secondaryCategory: MarketplaceCategory
"""The listing's very short description."""
shortDescription: String!
"""The short name of the listing used in its URL."""
slug: String!
"""URL to the listing's status page."""
statusUrl: URI
"""An email address for support for this listing's app."""
supportEmail: String
"""Either a URL or an email address for support for this listing's app."""
supportUrl: URI!
"""URL to the listing's terms of service."""
termsOfServiceUrl: URI
"""The HTTP URL for the Marketplace listing."""
url: URI!
"""Can the current viewer add plans for this Marketplace listing."""
viewerCanAddPlans: Boolean!
"""Can the current viewer approve this Marketplace listing."""
viewerCanApprove: Boolean!
"""Can the current viewer delist this Marketplace listing."""
viewerCanDelist: Boolean!
"""Can the current viewer edit this Marketplace listing."""
viewerCanEdit: Boolean!
"""
Can the current viewer edit the primary and secondary category of this
Marketplace listing.
"""
viewerCanEditCategories: Boolean!
"""Can the current viewer edit the plans for this Marketplace listing."""
viewerCanEditPlans: Boolean!
"""
Can the current viewer return this Marketplace listing to draft state
so it becomes editable again.
"""
viewerCanRedraft: Boolean!
"""
Can the current viewer reject this Marketplace listing by returning it to
an editable draft state or rejecting it entirely.
"""
viewerCanReject: Boolean!
"""
Can the current viewer request this listing be reviewed for display in
the Marketplace.
"""
viewerCanRequestApproval: Boolean!
"""
Indicates whether the current user has an active subscription to this Marketplace listing.
"""
viewerHasPurchased: Boolean!
"""
Indicates if the current user has purchased a subscription to this Marketplace listing
for all of the organizations the user owns.
"""
viewerHasPurchasedForAllOrganizations: Boolean!
"""
Does the current viewer role allow them to administer this Marketplace listing.
"""
viewerIsListingAdmin: Boolean!
}
"""Look up Marketplace Listings"""
type MarketplaceListingConnection {
"""A list of edges."""
edges: [MarketplaceListingEdge]
"""A list of nodes."""
nodes: [MarketplaceListing]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type MarketplaceListingEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: MarketplaceListing
}
"""Represents a 'mentioned' event on a given issue or pull request."""
type MentionedEvent 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!
}
"""Whether or not a PullRequest can be merged."""
enum MergeableState {
"""The pull request can be merged."""
MERGEABLE
"""The pull request cannot be merged due to merge conflicts."""
CONFLICTING
"""The mergeability of the pull request is still being calculated."""
UNKNOWN
}
"""Represents a 'merged' event on a given pull request."""
type MergedEvent implements Node & UniformResourceLocatable {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the commit associated with the `merge` event."""
commit: Commit
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""Identifies the Ref associated with the `merge` event."""
mergeRef: Ref
"""Identifies the name of the Ref associated with the `merge` event."""
mergeRefName: String!
"""PullRequest referenced by event."""
pullRequest: PullRequest!
"""The HTTP path for this merged event."""
resourcePath: URI!
"""The HTTP URL for this merged event."""
url: URI!
}
"""Represents a Milestone object on a given repository."""
type Milestone implements Node & Closable & UniformResourceLocatable {
"""
`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
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the actor who created the milestone."""
creator: Actor
"""Identifies the description of the milestone."""
description: String
"""Identifies the due date of the milestone."""
dueOn: DateTime
id: ID!
"""A list of issues associated with the milestone."""
issues(
"""Ordering options for issues returned from the connection."""
orderBy: IssueOrder
"""A list of label names to filter the pull requests by."""
labels: [String!]
"""A list of states to filter the issues by."""
states: [IssueState!]
"""
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
): IssueConnection!
"""Identifies the number of the milestone."""
number: Int!
"""A list of pull requests associated with the milestone."""
pullRequests(
"""A list of states to filter the pull requests by."""
states: [PullRequestState!]
"""A list of label names to filter the pull requests by."""
labels: [String!]
"""The head ref name to filter the pull requests by."""
headRefName: String
"""The base ref name to filter the pull requests by."""
baseRefName: String
"""Ordering options for pull requests returned from the connection."""
orderBy: IssueOrder
"""
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
): PullRequestConnection!
"""The repository associated with this milestone."""
repository: Repository!
"""The HTTP path for this milestone"""
resourcePath: URI!
"""Identifies the state of the milestone."""
state: MilestoneState!
"""Identifies the title of the milestone."""
title: String!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this milestone"""
url: URI!
}
"""The connection type for Milestone."""
type MilestoneConnection {
"""A list of edges."""
edges: [MilestoneEdge]
"""A list of nodes."""
nodes: [Milestone]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""Represents a 'milestoned' event on a given issue or pull request."""
type MilestonedEvent 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 'milestoned' event.
"""
milestoneTitle: String!
"""Object referenced by event."""
subject: MilestoneItem!
}
"""An edge in a connection."""
type MilestoneEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Milestone
}
"""Types that can be inside a Milestone."""
union MilestoneItem = Issue | PullRequest
"""Ordering options for milestone connections."""
input MilestoneOrder {
"""The field to order milestones by."""
field: MilestoneOrderField!
"""The ordering direction."""
direction: OrderDirection!
}
"""Properties by which milestone connections can be ordered."""
enum MilestoneOrderField {
"""Order milestones by when they are due."""
DUE_DATE
"""Order milestones by when they were created."""
CREATED_AT
"""Order milestones by when they were last updated."""
UPDATED_AT
"""Order milestones by their number."""
NUMBER
}
"""The possible states of a milestone."""
enum MilestoneState {
"""A milestone that is still open."""
OPEN
"""A milestone that has been closed."""
CLOSED
}
"""Autogenerated input type of MinimizeComment"""
input MinimizeCommentInput {
"""The Node ID of the subject to modify."""
subjectId: ID!
"""The classification of comment"""
classifier: ReportedContentClassifiers!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""
Represents a 'moved_columns_in_project' event on a given issue or pull request.
"""
type MovedColumnsInProjectEvent 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 MoveProjectCard"""
input MoveProjectCardInput {
"""The id of the card to move."""
cardId: ID!
"""The id of the column to move it into."""
columnId: ID!
"""
Place the new card after the card with this id. Pass null to place it at the top.
"""
afterCardId: ID
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of MoveProjectCard"""
type MoveProjectCardPayload {
"""The new edge of the moved card."""
cardEdge: ProjectCardEdge
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated input type of MoveProjectColumn"""
input MoveProjectColumnInput {
"""The id of the column to move."""
columnId: ID!
"""
Place the new column after the column with this id. Pass null to place it at the front.
"""
afterColumnId: ID
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of MoveProjectColumn"""
type MoveProjectColumnPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The new edge of the moved column."""
columnEdge: ProjectColumnEdge
}
"""The root query for implementing GraphQL mutations."""
type Mutation {
"""Applies a suggested topic to the repository."""
acceptTopicSuggestion(input: AcceptTopicSuggestionInput!): AcceptTopicSuggestionPayload
"""Adds a comment to an Issue or Pull Request."""
addComment(input: AddCommentInput!): AddCommentPayload
"""
Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both.
"""
addProjectCard(input: AddProjectCardInput!): AddProjectCardPayload
"""Adds a column to a Project."""
addProjectColumn(input: AddProjectColumnInput!): AddProjectColumnPayload
"""Adds a review to a Pull Request."""
addPullRequestReview(input: AddPullRequestReviewInput!): AddPullRequestReviewPayload
"""Adds a comment to a review."""
addPullRequestReviewComment(input: AddPullRequestReviewCommentInput!): AddPullRequestReviewCommentPayload
"""Adds a reaction to a subject."""
addReaction(input: AddReactionInput!): AddReactionPayload
"""Adds a star to a Starrable."""
addStar(input: AddStarInput!): AddStarPayload
"""Create a new branch protection rule"""
createBranchProtectionRule(input: CreateBranchProtectionRuleInput!): CreateBranchProtectionRulePayload
"""Creates a new project."""
createProject(input: CreateProjectInput!): CreateProjectPayload
"""Rejects a suggested topic for the repository."""
declineTopicSuggestion(input: DeclineTopicSuggestionInput!): DeclineTopicSuggestionPayload
"""Delete a branch protection rule"""
deleteBranchProtectionRule(input: DeleteBranchProtectionRuleInput!): DeleteBranchProtectionRulePayload
"""Deletes a project."""
deleteProject(input: DeleteProjectInput!): DeleteProjectPayload
"""Deletes a project card."""
deleteProjectCard(input: DeleteProjectCardInput!): DeleteProjectCardPayload
"""Deletes a project column."""
deleteProjectColumn(input: DeleteProjectColumnInput!): DeleteProjectColumnPayload
"""Deletes a pull request review."""
deletePullRequestReview(input: DeletePullRequestReviewInput!): DeletePullRequestReviewPayload
"""Dismisses an approved or rejected pull request review."""
dismissPullRequestReview(input: DismissPullRequestReviewInput!): DismissPullRequestReviewPayload
"""Lock a lockable object"""
lockLockable(input: LockLockableInput!): LockLockablePayload
"""Moves a project card to another place."""
moveProjectCard(input: MoveProjectCardInput!): MoveProjectCardPayload
"""Moves a project column to another place."""
moveProjectColumn(input: MoveProjectColumnInput!): MoveProjectColumnPayload
"""
Removes outside collaborator from all repositories in an organization.
"""
removeOutsideCollaborator(input: RemoveOutsideCollaboratorInput!): RemoveOutsideCollaboratorPayload
"""Removes a reaction from a subject."""
removeReaction(input: RemoveReactionInput!): RemoveReactionPayload
"""Removes a star from a Starrable."""
removeStar(input: RemoveStarInput!): RemoveStarPayload
"""Set review requests on a pull request."""
requestReviews(input: RequestReviewsInput!): RequestReviewsPayload
"""Submits a pending pull request review."""
submitPullRequestReview(input: SubmitPullRequestReviewInput!): SubmitPullRequestReviewPayload
"""Unlock a lockable object"""
unlockLockable(input: UnlockLockableInput!): UnlockLockablePayload
"""Create a new branch protection rule"""
updateBranchProtectionRule(input: UpdateBranchProtectionRuleInput!): UpdateBranchProtectionRulePayload
"""Updates an existing project."""
updateProject(input: UpdateProjectInput!): UpdateProjectPayload
"""Updates an existing project card."""
updateProjectCard(input: UpdateProjectCardInput!): UpdateProjectCardPayload
"""Updates an existing project column."""
updateProjectColumn(input: UpdateProjectColumnInput!): UpdateProjectColumnPayload
"""Updates the body of a pull request review."""
updatePullRequestReview(input: UpdatePullRequestReviewInput!): UpdatePullRequestReviewPayload
"""Updates a pull request review comment."""
updatePullRequestReviewComment(input: UpdatePullRequestReviewCommentInput!): UpdatePullRequestReviewCommentPayload
"""Updates the state for subscribable subjects."""
updateSubscription(input: UpdateSubscriptionInput!): UpdateSubscriptionPayload
"""Replaces the repository's topics with the given topics."""
updateTopics(input: UpdateTopicsInput!): UpdateTopicsPayload
}
"""An object with an ID."""
interface Node {
"""ID of the object."""
id: ID!
}
"""
Possible directions in which to order a list of items when provided an `orderBy` argument.
"""
enum OrderDirection {
"""Specifies an ascending order for a given `orderBy` argument."""
ASC
"""Specifies a descending order for a given `orderBy` argument."""
DESC
}
"""
An account on GitHub, with one or more owners, that has repositories, members and teams.
"""
type Organization implements Node & Actor & RegistryPackageOwner & RegistryPackageSearch & ProjectOwner & RepositoryOwner & UniformResourceLocatable {
"""A URL pointing to the organization's public avatar."""
avatarUrl(
"""The size of the resulting square image."""
size: Int
): URI!
"""Identifies the primary key from the database."""
databaseId: Int
"""The organization's public profile description."""
description: String
"""The organization's public email."""
email: String
id: ID!
"""Whether the organization has verified its profile email and website."""
isVerified: Boolean!
"""The organization's public profile location."""
location: String
"""The organization's login name."""
login: String!
"""A list of users who are members of this organization."""
members(
"""
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! @deprecated(reason: "The `members` field is deprecated and will be removed soon. Use `Organization.membersWithRole` instead. Removal on 2019-04-01 UTC.")
"""A list of users who are members of this organization."""
membersWithRole(
"""
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
): OrganizationMemberConnection!
"""The organization's public profile name."""
name: String
"""The HTTP path creating a new team"""
newTeamResourcePath: URI!
"""The HTTP URL creating a new team"""
newTeamUrl: URI!
"""The billing email for the organization."""
organizationBillingEmail: String
"""A list of users who have been invited to join this organization."""
pendingMembers(
"""
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!
"""A list of repositories this user has pinned to their profile"""
pinnedRepositories(
"""If non-null, filters repositories according to privacy"""
privacy: RepositoryPrivacy
"""Ordering options for repositories returned from the connection"""
orderBy: RepositoryOrder
"""
Array of viewer's affiliation options for repositories returned from the
connection. For example, OWNER will include only repositories that the
current viewer owns.
"""
affiliations: [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.
"""
ownerAffiliations: [RepositoryAffiliation]
"""
If non-null, filters repositories according to whether they have been locked
"""
isLocked: Boolean
"""
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
): RepositoryConnection!
"""Find project by number."""
project(
"""The project number to find."""
number: Int!
): Project
"""A list of projects under the owner."""
projects(
"""Ordering options for projects returned from the connection"""
orderBy: ProjectOrder
"""Query to search projects by, currently only searching by name."""
search: String
"""A list of states to filter the projects by."""
states: [ProjectState!]
"""
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
): ProjectConnection!
"""The HTTP path listing organization's projects"""
projectsResourcePath: URI!
"""The HTTP URL listing organization's projects"""
projectsUrl: URI!
"""A list of repositories that the user owns."""
repositories(
"""If non-null, filters repositories according to privacy"""
privacy: RepositoryPrivacy
"""Ordering options for repositories returned from the connection"""
orderBy: RepositoryOrder
"""
Array of viewer's affiliation options for repositories returned from the
connection. For example, OWNER will include only repositories that the
current viewer owns.
"""
affiliations: [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.
"""
ownerAffiliations: [RepositoryAffiliation]
"""
If non-null, filters repositories according to whether they have been locked
"""
isLocked: Boolean
"""
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 repositories according to whether they are forks of another repository
"""
isFork: Boolean
): RepositoryConnection!
"""Find Repository."""
repository(
"""Name of Repository to find."""
name: String!
): Repository
"""
When true the organization requires all members, billing managers, and outside
collaborators to enable two-factor authentication.
"""
requiresTwoFactorAuthentication: Boolean
"""The HTTP path for this organization."""
resourcePath: URI!
"""The Organization's SAML Identity Providers"""
samlIdentityProvider: OrganizationIdentityProvider
"""Find an organization's team by its slug."""
team(
"""The name or slug of the team to find."""
slug: String!
): Team
"""A list of teams in this organization."""
teams(
"""If non-null, filters teams according to privacy"""
privacy: TeamPrivacy
"""
If non-null, filters teams according to whether the viewer is an admin or member on team
"""
role: TeamRole
"""If non-null, filters teams with query on team name and team slug"""
query: String
"""User logins to filter by"""
userLogins: [String!]
"""Ordering options for teams returned from the connection"""
orderBy: TeamOrder
"""
If true, filters teams that are mapped to an LDAP Group (Enterprise only)
"""
ldapMapped: Boolean
"""If true, restrict to only root teams"""
rootTeamsOnly: Boolean = false
"""
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
): TeamConnection!
"""The HTTP path listing organization's teams"""
teamsResourcePath: URI!
"""The HTTP URL listing organization's teams"""
teamsUrl: URI!
"""The HTTP URL for this organization."""
url: URI!
"""Organization is adminable by the viewer."""
viewerCanAdminister: Boolean!
"""Can the current viewer create new projects on this owner."""
viewerCanCreateProjects: Boolean!
"""Viewer can create repositories on this organization"""
viewerCanCreateRepositories: Boolean!
"""Viewer can create teams on this organization."""
viewerCanCreateTeams: Boolean!
"""Viewer is an active member of this organization."""
viewerIsAMember: Boolean!
"""The organization's public profile URL."""
websiteUrl: URI
}
"""The connection type for Organization."""
type OrganizationConnection {
"""A list of edges."""
edges: [OrganizationEdge]
"""A list of nodes."""
nodes: [Organization]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type OrganizationEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Organization
}
"""
An Identity Provider configured to provision SAML and SCIM identities for Organizations
"""
type OrganizationIdentityProvider implements Node {
"""
The digest algorithm used to sign SAML requests for the Identity Provider.
"""
digestMethod: URI
"""External Identities provisioned by this Identity Provider"""
externalIdentities(
"""
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
): ExternalIdentityConnection!
id: ID!
"""
The x509 certificate used by the Identity Provder to sign assertions and responses.
"""
idpCertificate: X509Certificate
"""The Issuer Entity ID for the SAML Identity Provider"""
issuer: String
"""Organization this Identity Provider belongs to"""
organization: Organization
"""
The signature algorithm used to sign SAML requests for the Identity Provider.
"""
signatureMethod: URI
"""The URL endpoint for the Identity Provider's SAML SSO."""
ssoUrl: URI
}
"""An Invitation for a user to an organization."""
type OrganizationInvitation implements Node {
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""The email address of the user invited to the organization."""
email: String
id: ID!
"""The type of invitation that was sent (e.g. email, user)."""
invitationType: OrganizationInvitationType!
"""The user who was invited to the organization."""
invitee: User
"""The user who created the invitation."""
inviter: User!
"""The organization the invite is for"""
organization: Organization!
"""The user's pending role in the organization (e.g. member, owner)."""
role: OrganizationInvitationRole!
}
"""The connection type for OrganizationInvitation."""
type OrganizationInvitationConnection {
"""A list of edges."""
edges: [OrganizationInvitationEdge]
"""A list of nodes."""
nodes: [OrganizationInvitation]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type OrganizationInvitationEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: OrganizationInvitation
}
"""The possible organization invitation roles."""
enum OrganizationInvitationRole {
"""The user is invited to be a direct member of the organization."""
DIRECT_MEMBER
"""The user is invited to be an admin of the organization."""
ADMIN
"""The user is invited to be a billing manager of the organization."""
BILLING_MANAGER
"""The user's previous role will be reinstated."""
REINSTATE
}
"""The possible organization invitation types."""
enum OrganizationInvitationType {
"""The invitation was to an existing user."""
USER
"""The invitation was to an email address."""
EMAIL
}
"""The connection type for User."""
type OrganizationMemberConnection {
"""A list of edges."""
edges: [OrganizationMemberEdge]
"""A list of nodes."""
nodes: [User]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""Represents a user within an organization."""
type OrganizationMemberEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: User
"""The role this user has in the organization."""
role: OrganizationMemberRole
}
"""The possible roles within an organization for its members."""
enum OrganizationMemberRole {
"""The user is a member of the organization."""
MEMBER
"""The user is an administrator of the organization."""
ADMIN
}
"""Information about pagination in a connection."""
type PageInfo {
"""When paginating forwards, the cursor to continue."""
endCursor: String
"""When paginating forwards, are there more items?"""
hasNextPage: Boolean!
"""When paginating backwards, are there more items?"""
hasPreviousPage: Boolean!
"""When paginating backwards, the cursor to continue."""
startCursor: String
}
"""Autogenerated input type of PinIssue"""
input PinIssueInput {
"""The ID of the issue to be pinned"""
issueId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Represents a 'pinned' event on a given issue or pull request."""
type PinnedEvent 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 issue associated with the event."""
issue: Issue!
}
"""
Projects manage issues, pull requests and notes within a project owner.
"""
type Project implements Node & Closable & Updatable {
"""The project's description body."""
body: String
"""The projects description body rendered to HTML."""
bodyHTML: HTML!
"""
`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
"""List of columns in the project"""
columns(
"""
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
): ProjectColumnConnection!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""The actor who originally created the project."""
creator: Actor
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
"""The project's name."""
name: String!
"""The project's number."""
number: Int!
"""
The project's owner. Currently limited to repositories and organizations.
"""
owner: ProjectOwner!
"""List of pending cards in this project"""
pendingCards(
"""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!
"""The HTTP path for this project"""
resourcePath: URI!
"""Whether the project is open or closed."""
state: ProjectState!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this project"""
url: URI!
"""Check if the current viewer can update this object."""
viewerCanUpdate: Boolean!
}
"""A card in a project."""
type ProjectCard implements Node {
"""
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.
"""
column: ProjectColumn
"""The card content item"""
content: ProjectCardItem
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""The actor who created this card"""
creator: Actor
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
"""Whether the card is archived"""
isArchived: Boolean!
"""The card note"""
note: String
"""The project that contains this card."""
project: Project!
"""The HTTP path for this card"""
resourcePath: URI!
"""The state of ProjectCard"""
state: ProjectCardState
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this card"""
url: URI!
}
"""The possible archived states of a project card."""
enum ProjectCardArchivedState {
"""A project card that is archived"""
ARCHIVED
"""A project card that is not archived"""
NOT_ARCHIVED
}
"""The connection type for ProjectCard."""
type ProjectCardConnection {
"""A list of edges."""
edges: [ProjectCardEdge]
"""A list of nodes."""
nodes: [ProjectCard]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type ProjectCardEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: ProjectCard
}
"""Types that can be inside Project Cards."""
union ProjectCardItem = Issue | PullRequest
"""Various content states of a ProjectCard"""
enum ProjectCardState {
"""The card has content only."""
CONTENT_ONLY
"""The card has a note only."""
NOTE_ONLY
"""The card is redacted."""
REDACTED
}
"""A column inside a project."""
type ProjectColumn implements Node {
"""List of cards in the column"""
cards(
"""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 the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
"""The project column's name."""
name: String!
"""The project that contains this column."""
project: Project!
"""The semantic purpose of the column"""
purpose: ProjectColumnPurpose
"""The HTTP path for this project column"""
resourcePath: URI!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this project column"""
url: URI!
}
"""The connection type for ProjectColumn."""
type ProjectColumnConnection {
"""A list of edges."""
edges: [ProjectColumnEdge]
"""A list of nodes."""
nodes: [ProjectColumn]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type ProjectColumnEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: ProjectColumn
}
"""The semantic purpose of the column - todo, in progress, or done."""
enum ProjectColumnPurpose {
"""The column contains cards still to be worked on"""
TODO
"""The column contains cards which are currently being worked on"""
IN_PROGRESS
"""The column contains cards which are complete"""
DONE
}
"""A list of projects associated with the owner."""
type ProjectConnection {
"""A list of edges."""
edges: [ProjectEdge]
"""A list of nodes."""
nodes: [Project]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type ProjectEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Project
}
"""Ways in which lists of projects can be ordered upon return."""
input ProjectOrder {
"""The field in which to order projects by."""
field: ProjectOrderField!
"""The direction in which to order projects by the specified field."""
direction: OrderDirection!
}
"""Properties by which project connections can be ordered."""
enum ProjectOrderField {
"""Order projects by creation time"""
CREATED_AT
"""Order projects by update time"""
UPDATED_AT
"""Order projects by name"""
NAME
}
"""Represents an owner of a Project."""
interface ProjectOwner {
id: ID!
"""Find project by number."""
project(
"""The project number to find."""
number: Int!
): Project
"""A list of projects under the owner."""
projects(
"""Ordering options for projects returned from the connection"""
orderBy: ProjectOrder
"""Query to search projects by, currently only searching by name."""
search: String
"""A list of states to filter the projects by."""
states: [ProjectState!]
"""
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
): ProjectConnection!
"""The HTTP path listing owners projects"""
projectsResourcePath: URI!
"""The HTTP URL listing owners projects"""
projectsUrl: URI!
"""Can the current viewer create new projects on this owner."""
viewerCanCreateProjects: Boolean!
}
"""State of the project; either 'open' or 'closed'"""
enum ProjectState {
"""The project is open."""
OPEN
"""The project is closed."""
CLOSED
}
"""A repository protected branch."""
type ProtectedBranch implements Node {
"""The actor who created this protected branch."""
creator: Actor
"""
Will new commits pushed to this branch dismiss pull request review approvals.
"""
hasDismissableStaleReviews: Boolean!
"""Are reviews required to update this branch."""
hasRequiredReviews: Boolean!
"""Are status checks required to update this branch."""
hasRequiredStatusChecks: Boolean!
"""Is pushing to this branch restricted."""
hasRestrictedPushes: Boolean!
"""Is dismissal of pull request reviews restricted."""
hasRestrictedReviewDismissals: Boolean!
"""Are branches required to be up to date before merging."""
hasStrictRequiredStatusChecks: Boolean!
id: ID!
"""Can admins overwrite branch protection."""
isAdminEnforced: Boolean!
"""The name of the protected branch rule."""
name: String!
"""A list push allowances for this protected branch."""
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 protected branch."""
repository: Repository!
"""
List of required status check contexts that must pass for commits to be accepted to this branch.
"""
requiredStatusCheckContexts: [String]
"""A list review dismissal allowances for this protected branch."""
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!
}
"""The connection type for ProtectedBranch."""
type ProtectedBranchConnection {
"""A list of edges."""
edges: [ProtectedBranchEdge]
"""A list of nodes."""
nodes: [ProtectedBranch]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type ProtectedBranchEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: ProtectedBranch
}
"""A user's public key."""
type PublicKey implements Node {
id: ID!
"""The public key string"""
key: String!
}
"""The connection type for PublicKey."""
type PublicKeyConnection {
"""A list of edges."""
edges: [PublicKeyEdge]
"""A list of nodes."""
nodes: [PublicKey]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type PublicKeyEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: PublicKey
}
"""A repository pull request."""
type PullRequest implements Node & Assignable & Closable & Comment & Updatable & UpdatableComment & Labelable & Lockable & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable {
"""Reason that the conversation was locked."""
activeLockReason: LockReason
"""The number of additions in this pull request."""
additions: Int!
"""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 base Ref associated with the pull request."""
baseRef: Ref
"""
Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
"""
baseRefName: String!
"""
Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.
"""
baseRefOid: GitObjectID!
"""The body as Markdown."""
body: String!
"""The body rendered to HTML."""
bodyHTML: HTML!
"""The body rendered to text."""
bodyText: String!
"""The number of changed files in this pull request."""
changedFiles: Int!
"""`true` if the pull request is closed"""
closed: Boolean!
"""Identifies the date and time when the object was closed."""
closedAt: DateTime
"""A list of comments associated with the pull request."""
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!
"""
A list of commits present in this pull request's head branch not present in the base branch.
"""
commits(
"""
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
): PullRequestCommitConnection!
"""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 number of deletions in this pull request."""
deletions: Int!
"""The actor who edited this pull request's body."""
editor: Actor
"""Identifies the head Ref associated with the pull request."""
headRef: Ref
"""
Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
"""
headRefName: String!
"""
Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.
"""
headRefOid: GitObjectID!
"""The repository associated with this pull request's head Ref."""
headRepository: Repository
"""
The owner of the repository associated with this pull request's head Ref.
"""
headRepositoryOwner: RepositoryOwner
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""The head and base repositories are different."""
isCrossRepository: 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 pull request is locked"""
locked: Boolean!
"""Indicates whether maintainers can modify the pull request."""
maintainerCanModify: Boolean!
"""The commit that was created when this pull request was merged."""
mergeCommit: Commit
"""
Whether or not the pull request can be merged based on the existence of merge conflicts.
"""
mergeable: MergeableState!
"""Whether or not the pull request was merged."""
merged: Boolean!
"""The date and time that the pull request was merged."""
mergedAt: DateTime
"""The actor who merged the pull request."""
mergedBy: Actor
"""Identifies the milestone associated with the pull request."""
milestone: Milestone
"""Identifies the pull request number."""
number: Int!
"""
A list of Users that are participating in the Pull Request 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!
"""The permalink to the pull request."""
permalink: URI!
"""
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 the
`mergeable` field for more details on the mergeability of the pull request.
"""
potentialMergeCommit: Commit
"""List of project cards associated with this pull request."""
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 pull request."""
resourcePath: URI!
"""The HTTP path for reverting this pull request."""
revertResourcePath: URI!
"""The HTTP URL for reverting this pull request."""
revertUrl: URI!
"""A list of review requests associated with the pull request."""
reviewRequests(
"""
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
): ReviewRequestConnection
"""A list of reviews associated with the pull request."""
reviews(
"""
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
"""A list of states to filter the reviews."""
states: [PullRequestReviewState!]
"""Filter by author of the review."""
author: String
): PullRequestReviewConnection
"""Identifies the state of the pull request."""
state: PullRequestState!
"""
A list of reviewer suggestions based on commit history and past review comments.
"""
suggestedReviewers: [SuggestedReviewer]!
"""
A list of events, comments, commits, etc. associated with the pull request.
"""
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
): PullRequestTimelineConnection!
"""Identifies the pull request title."""
title: String!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this pull request."""
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
"""Whether or not the viewer can apply suggestion."""
viewerCanApplySuggestion: Boolean!
"""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
}
"""Represents a Git commit part of a pull request."""
type PullRequestCommit implements Node & UniformResourceLocatable {
"""The Git commit object"""
commit: Commit!
id: ID!
"""The pull request this commit belongs to"""
pullRequest: PullRequest!
"""The HTTP path for this pull request commit"""
resourcePath: URI!
"""The HTTP URL for this pull request commit"""
url: URI!
}
"""The connection type for PullRequestCommit."""
type PullRequestCommitConnection {
"""A list of edges."""
edges: [PullRequestCommitEdge]
"""A list of nodes."""
nodes: [PullRequestCommit]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type PullRequestCommitEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: PullRequestCommit
}
"""The connection type for PullRequest."""
type PullRequestConnection {
"""A list of edges."""
edges: [PullRequestEdge]
"""A list of nodes."""
nodes: [PullRequest]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type PullRequestEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: PullRequest
}
"""Ways in which lists of issues can be ordered upon return."""
input PullRequestOrder {
"""The field in which to order pull requests by."""
field: PullRequestOrderField!
"""The direction in which to order pull requests by the specified field."""
direction: OrderDirection!
}
"""Properties by which pull_requests connections can be ordered."""
enum PullRequestOrderField {
"""Order pull_requests by creation time"""
CREATED_AT
"""Order pull_requests by update time"""
UPDATED_AT
}
"""The possible PubSub channels for a pull request."""
enum PullRequestPubSubTopic {
"""The channel ID for observing pull request updates."""
UPDATED
"""The channel ID for marking an pull request as read."""
MARKASREAD
"""The channel ID for observing head ref updates."""
HEAD_REF
"""The channel ID for updating items on the pull request timeline."""
TIMELINE
"""The channel ID for observing pull request state updates."""
STATE
}
"""A review object for a given pull request."""
type PullRequestReview 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 pull request review body."""
body: String!
"""The body of this review rendered to HTML."""
bodyHTML: HTML!
"""The body of this review rendered as plain text."""
bodyText: String!
"""A list of review comments for the current pull request review."""
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
): PullRequestReviewCommentConnection!
"""Identifies the commit associated with this pull request review."""
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!
"""The moment the editor made the last edit"""
lastEditedAt: DateTime
"""A list of teams that this review was made on behalf of."""
onBehalfOf(
"""
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
): TeamConnection!
"""Identifies when the comment was published at."""
publishedAt: DateTime
"""Identifies the pull request associated with this pull request review."""
pullRequest: PullRequest!
"""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 PullRequestReview."""
resourcePath: URI!
"""Identifies the current state of the pull request review."""
state: PullRequestReviewState!
"""Identifies when the Pull Request Review was submitted"""
submittedAt: DateTime
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL permalink for this PullRequestReview."""
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!
"""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!
}
"""A review comment associated with a given repository pull request."""
type PullRequestReviewComment 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!
"""The comment body of this review comment."""
body: String!
"""The comment body of this review comment rendered to HTML."""
bodyHTML: HTML!
"""The comment body of this review comment rendered as plain text."""
bodyText: String!
"""Identifies the commit associated with the comment."""
commit: Commit!
"""Identifies when the comment 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 diff hunk to which the comment applies."""
diffHunk: String!
"""Identifies when the comment was created in a draft state."""
draftedAt: DateTime!
"""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 original commit associated with the comment."""
originalCommit: Commit
"""The original line index in the diff to which the comment applies."""
originalPosition: Int!
"""Identifies when the comment body is outdated"""
outdated: Boolean!
"""The path to which the comment applies."""
path: String!
"""The line index in the diff to which the comment applies."""
position: Int
"""Identifies when the comment was published at."""
publishedAt: DateTime
"""The pull request associated with this review comment."""
pullRequest: PullRequest!
"""The pull request review associated with this review comment."""
pullRequestReview: PullRequestReview
"""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 comment this is a reply to."""
replyTo: PullRequestReviewComment
"""The repository associated with this node."""
repository: Repository!
"""The HTTP path permalink for this review comment."""
resourcePath: URI!
"""Identifies the state of the comment."""
state: PullRequestReviewCommentState!
"""Identifies when the comment was last updated."""
updatedAt: DateTime!
"""The HTTP URL permalink for this review 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 PullRequestReviewComment."""
type PullRequestReviewCommentConnection {
"""A list of edges."""
edges: [PullRequestReviewCommentEdge]
"""A list of nodes."""
nodes: [PullRequestReviewComment]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type PullRequestReviewCommentEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: PullRequestReviewComment
}
"""The possible states of a pull request review comment."""
enum PullRequestReviewCommentState {
"""A comment that is part of a pending review"""
PENDING
"""A comment that is part of a submitted review"""
SUBMITTED
}
"""The connection type for PullRequestReview."""
type PullRequestReviewConnection {
"""A list of edges."""
edges: [PullRequestReviewEdge]
"""A list of nodes."""
nodes: [PullRequestReview]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type PullRequestReviewEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: PullRequestReview
}
"""The possible events to perform on a pull request review."""
enum PullRequestReviewEvent {
"""Submit general feedback without explicit approval."""
COMMENT
"""Submit feedback and approve merging these changes."""
APPROVE
"""Submit feedback that must be addressed before merging."""
REQUEST_CHANGES
"""Dismiss review so it now longer effects merging."""
DISMISS
}
"""The possible states of a pull request review."""
enum PullRequestReviewState {
"""A review that has not yet been submitted."""
PENDING
"""An informational review."""
COMMENTED
"""A review allowing the pull request to merge."""
APPROVED
"""A review blocking the pull request from merging."""
CHANGES_REQUESTED
"""A review that has been dismissed."""
DISMISSED
}
"""A threaded list of comments for a given pull request."""
type PullRequestReviewThread implements Node {
"""A list of pull request comments associated with the 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
): PullRequestReviewCommentConnection!
id: ID!
"""Identifies the pull request associated with this thread."""
pullRequest: PullRequest!
"""Identifies the repository associated with this thread."""
repository: Repository!
}
"""The possible states of a pull request."""
enum PullRequestState {
"""A pull request that is still open."""
OPEN
"""A pull request that has been closed without being merged."""
CLOSED
"""A pull request that has been closed by being merged."""
MERGED
}
"""The connection type for PullRequestTimelineItem."""
type PullRequestTimelineConnection {
"""A list of edges."""
edges: [PullRequestTimelineItemEdge]
"""A list of nodes."""
nodes: [PullRequestTimelineItem]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An item in an pull request timeline"""
union PullRequestTimelineItem = Commit | CommitCommentThread | PullRequestReview | PullRequestReviewThread | PullRequestReviewComment | IssueComment | ClosedEvent | ReopenedEvent | SubscribedEvent | UnsubscribedEvent | MergedEvent | ReferencedEvent | CrossReferencedEvent | AssignedEvent | UnassignedEvent | LabeledEvent | UnlabeledEvent | MilestonedEvent | DemilestonedEvent | RenamedTitleEvent | LockedEvent | UnlockedEvent | DeployedEvent | DeploymentEnvironmentChangedEvent | HeadRefDeletedEvent | HeadRefRestoredEvent | HeadRefForcePushedEvent | BaseRefForcePushedEvent | ReviewRequestedEvent | ReviewRequestRemovedEvent | ReviewDismissedEvent
"""An edge in a connection."""
type PullRequestTimelineItemEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: PullRequestTimelineItem
}
"""An item in a pull request timeline"""
union PullRequestTimelineItems = PullRequestCommit | PullRequestReview | PullRequestReviewThread | BaseRefChangedEvent | BaseRefForcePushedEvent | DeployedEvent | DeploymentEnvironmentChangedEvent | HeadRefDeletedEvent | HeadRefForcePushedEvent | HeadRefRestoredEvent | MergedEvent | ReviewDismissedEvent | ReviewRequestedEvent | ReviewRequestRemovedEvent | IssueComment | CrossReferencedEvent | AddedToProjectEvent | AssignedEvent | ClosedEvent | CommentDeletedEvent | ConvertedNoteToIssueEvent | DemilestonedEvent | LabeledEvent | LockedEvent | MentionedEvent | MilestonedEvent | MovedColumnsInProjectEvent | PinnedEvent | ReferencedEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnpinnedEvent | UnsubscribedEvent
"""An edge in a connection."""
type PullRequestTimelineItemsEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: PullRequestTimelineItems
}
"""The possible item types found in a timeline."""
enum PullRequestTimelineItemsItemType {
"""Represents a Git commit part of a pull request."""
PULL_REQUEST_COMMIT
"""Represents a commit comment thread part of a pull request."""
PULL_REQUEST_COMMIT_COMMENT_THREAD
"""A review object for a given pull request."""
PULL_REQUEST_REVIEW
"""A threaded list of comments for a given pull request."""
PULL_REQUEST_REVIEW_THREAD
"""
Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
"""
PULL_REQUEST_REVISION_MARKER
"""
Represents a 'base_ref_changed' event on a given issue or pull request.
"""
BASE_REF_CHANGED_EVENT
"""Represents a 'base_ref_force_pushed' event on a given pull request."""
BASE_REF_FORCE_PUSHED_EVENT
"""Represents a 'deployed' event on a given pull request."""
DEPLOYED_EVENT
"""
Represents a 'deployment_environment_changed' event on a given pull request.
"""
DEPLOYMENT_ENVIRONMENT_CHANGED_EVENT
"""Represents a 'head_ref_deleted' event on a given pull request."""
HEAD_REF_DELETED_EVENT
"""Represents a 'head_ref_force_pushed' event on a given pull request."""
HEAD_REF_FORCE_PUSHED_EVENT
"""Represents a 'head_ref_restored' event on a given pull request."""
HEAD_REF_RESTORED_EVENT
"""Represents a 'merged' event on a given pull request."""
MERGED_EVENT
"""
Represents a 'review_dismissed' event on a given issue or pull request.
"""
REVIEW_DISMISSED_EVENT
"""Represents an 'review_requested' event on a given pull request."""
REVIEW_REQUESTED_EVENT
"""Represents an 'review_request_removed' event on a given pull request."""
REVIEW_REQUEST_REMOVED_EVENT
"""Represents a comment on an Issue."""
ISSUE_COMMENT
"""Represents a mention made by one issue or pull request to another."""
CROSS_REFERENCED_EVENT
"""
Represents a 'added_to_project' event on a given issue or pull request.
"""
ADDED_TO_PROJECT_EVENT
"""Represents an 'assigned' event on any assignable object."""
ASSIGNED_EVENT
"""Represents a 'closed' event on any `Closable`."""
CLOSED_EVENT
"""
Represents a 'comment_deleted' event on a given issue or pull request.
"""
COMMENT_DELETED_EVENT
"""
Represents a 'converted_note_to_issue' event on a given issue or pull request.
"""
CONVERTED_NOTE_TO_ISSUE_EVENT
"""Represents a 'demilestoned' event on a given issue or pull request."""
DEMILESTONED_EVENT
"""Represents a 'labeled' event on a given issue or pull request."""
LABELED_EVENT
"""Represents a 'locked' event on a given issue or pull request."""
LOCKED_EVENT
"""Represents a 'mentioned' event on a given issue or pull request."""
MENTIONED_EVENT
"""Represents a 'milestoned' event on a given issue or pull request."""
MILESTONED_EVENT
"""
Represents a 'moved_columns_in_project' event on a given issue or pull request.
"""
MOVED_COLUMNS_IN_PROJECT_EVENT
"""Represents a 'pinned' event on a given issue or pull request."""
PINNED_EVENT
"""Represents a 'referenced' event on a given `ReferencedSubject`."""
REFERENCED_EVENT
"""
Represents a 'removed_from_project' event on a given issue or pull request.
"""
REMOVED_FROM_PROJECT_EVENT
"""Represents a 'renamed' event on a given issue or pull request"""
RENAMED_TITLE_EVENT
"""Represents a 'reopened' event on any `Closable`."""
REOPENED_EVENT
"""Represents a 'subscribed' event on a given `Subscribable`."""
SUBSCRIBED_EVENT
"""Represents a 'transferred' event on a given issue or pull request."""
TRANSFERRED_EVENT
"""Represents an 'unassigned' event on any assignable object."""
UNASSIGNED_EVENT
"""Represents an 'unlabeled' event on a given issue or pull request."""
UNLABELED_EVENT
"""Represents an 'unlocked' event on a given issue or pull request."""
UNLOCKED_EVENT
"""Represents an 'unpinned' event on a given issue or pull request."""
UNPINNED_EVENT
"""Represents an 'unsubscribed' event on a given `Subscribable`."""
UNSUBSCRIBED_EVENT
}
"""A team or user who has the ability to push to a protected branch."""
type PushAllowance implements Node {
"""The actor that can push."""
actor: PushAllowanceActor
"""
Identifies the branch protection rule associated with the allowed user or team.
"""
branchProtectionRule: BranchProtectionRule
id: ID!
}
"""Types that can be an actor."""
union PushAllowanceActor = User | Team
"""The connection type for PushAllowance."""
type PushAllowanceConnection {
"""A list of edges."""
edges: [PushAllowanceEdge]
"""A list of nodes."""
nodes: [PushAllowance]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type PushAllowanceEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: PushAllowance
}
"""The query root of GitHub's GraphQL interface."""
type Query {
"""Look up a code of conduct by its key"""
codeOfConduct(
"""The code of conduct's key"""
key: String!
): CodeOfConduct
"""Look up a code of conduct by its key"""
codesOfConduct: [CodeOfConduct]
"""Look up an open source license by its key"""
license(
"""The license's downcased SPDX ID"""
key: String!
): License
"""Return a list of known open source licenses"""
licenses: [License]!
"""Get alphabetically sorted list of Marketplace categories"""
marketplaceCategories(
"""Return only the specified categories."""
includeCategories: [String!]
"""Exclude categories with no listings."""
excludeEmpty: Boolean
"""Returns top level categories only, excluding any subcategories."""
excludeSubcategories: Boolean
): [MarketplaceCategory!]!
"""Look up a Marketplace category by its slug."""
marketplaceCategory(
"""The URL slug of the category."""
slug: String!
"""Also check topic aliases for the category slug"""
useTopicAliases: Boolean
): MarketplaceCategory
"""Look up a single Marketplace listing"""
marketplaceListing(
"""
Select the listing that matches this slug. It's the short name of the listing used in its URL.
"""
slug: String!
): MarketplaceListing
"""Look up Marketplace listings"""
marketplaceListings(
"""
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
"""Select only listings with the given category."""
categorySlug: String
"""Also check topic aliases for the category slug"""
useTopicAliases: Boolean
"""
Select listings to which user has admin access. If omitted, listings visible to the
viewer are returned.
"""
viewerCanAdmin: Boolean
"""Select listings that can be administered by the specified user."""
adminId: ID
"""Select listings for products owned by the specified organization."""
organizationId: ID
"""
Select listings visible to the viewer even if they are not approved. If omitted or
false, only approved listings will be returned.
"""
allStates: Boolean
"""
Select the listings with these slugs, if they are visible to the viewer.
"""
slugs: [String]
"""
Select only listings where the primary category matches the given category slug.
"""
primaryCategoryOnly: Boolean = false
"""Select only listings that offer a free trial."""
withFreeTrialsOnly: Boolean = false
): MarketplaceListingConnection!
"""Return information about the GitHub instance"""
meta: GitHubMetadata!
"""Fetches an object given its ID."""
node(
"""ID of the object."""
id: ID!
): Node
"""Lookup nodes by a list of IDs."""
nodes(
"""The list of node IDs."""
ids: [ID!]!
): [Node]!
"""Lookup a organization by login."""
organization(
"""The organization's login."""
login: String!
): Organization
"""The client's rate limit information."""
rateLimit(
"""If true, calculate the cost for the query without evaluating it"""
dryRun: Boolean = false
): RateLimit
"""
Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object
"""
relay: Query!
"""Lookup a given repository by the owner and repository name."""
repository(
"""The login field of a user or organization"""
owner: String!
"""The name of the repository"""
name: String!
): Repository
"""
Lookup a repository owner (ie. either a User or an Organization) by login.
"""
repositoryOwner(
"""The username to lookup the owner by."""
login: String!
): RepositoryOwner
"""Lookup resource by a URL."""
resource(
"""The URL."""
url: URI!
): UniformResourceLocatable
"""Perform a search across resources."""
search(
"""
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
"""The search string to look for."""
query: String!
"""The types of search items to search within."""
type: SearchType!
): SearchResultItemConnection!
"""Look up a topic by name."""
topic(
"""The topic's name."""
name: String!
): Topic
"""Lookup a user by login."""
user(
"""The user's login."""
login: String!
): User
"""The currently authenticated user."""
viewer: User!
}
"""Represents the client's rate limit."""
type RateLimit {
"""The point cost for the current query counting against the rate limit."""
cost: Int!
"""
The maximum number of points the client is permitted to consume in a 60 minute window.
"""
limit: Int!
"""The maximum number of nodes this query may return"""
nodeCount: Int!
"""The number of points remaining in the current rate limit window."""
remaining: Int!
"""
The time at which the current rate limit window resets in UTC epoch seconds.
"""
resetAt: DateTime!
}
"""Represents a subject that can be reacted on."""
interface Reactable {
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
"""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!
"""Can user react to this subject"""
viewerCanReact: Boolean!
}
"""The connection type for User."""
type ReactingUserConnection {
"""A list of edges."""
edges: [ReactingUserEdge]
"""A list of nodes."""
nodes: [User]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""Represents a user that's made a reaction."""
type ReactingUserEdge {
"""A cursor for use in pagination."""
cursor: String!
node: User!
"""The moment when the user made the reaction."""
reactedAt: DateTime!
}
"""An emoji reaction to a particular piece of content."""
type Reaction implements Node {
"""Identifies the emoji reaction."""
content: ReactionContent!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
"""The reactable piece of content"""
reactable: Reactable!
"""Identifies the user who created this reaction."""
user: User
}
"""A list of reactions that have been left on the subject."""
type ReactionConnection {
"""A list of edges."""
edges: [ReactionEdge]
"""A list of nodes."""
nodes: [Reaction]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
"""
Whether or not the authenticated user has left a reaction on the subject.
"""
viewerHasReacted: Boolean!
}
"""Emojis that can be attached to Issues, Pull Requests and Comments."""
enum ReactionContent {
"""Represents the 👍 emoji."""
THUMBS_UP
"""Represents the 👎 emoji."""
THUMBS_DOWN
"""Represents the 😄 emoji."""
LAUGH
"""Represents the 🎉 emoji."""
HOORAY
"""Represents the 😕 emoji."""
CONFUSED
"""Represents the ❤️ emoji."""
HEART
"""Represents the 🚀 emoji."""
ROCKET
"""Represents the 👀 emoji."""
EYES
}
"""An edge in a connection."""
type ReactionEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Reaction
}
"""A group of emoji reactions to a particular piece of content."""
type ReactionGroup {
"""Identifies the emoji reaction."""
content: ReactionContent!
"""Identifies when the reaction was created."""
createdAt: DateTime
"""The subject that was reacted to."""
subject: Reactable!
"""
Users who have reacted to the reaction subject with the emotion represented by this reaction group
"""
users(
"""
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
): ReactingUserConnection!
"""
Whether or not the authenticated user has left a reaction on the subject.
"""
viewerHasReacted: Boolean!
}
"""Ways in which lists of reactions can be ordered upon return."""
input ReactionOrder {
"""The field in which to order reactions by."""
field: ReactionOrderField!
"""The direction in which to order reactions by the specified field."""
direction: OrderDirection!
}
"""A list of fields that reactions can be ordered by."""
enum ReactionOrderField {
"""Allows ordering a list of reactions by when they were created."""
CREATED_AT
}
"""Represents a Git reference."""
type Ref implements Node {
"""A list of pull requests with this ref as the head ref."""
associatedPullRequests(
"""A list of states to filter the pull requests by."""
states: [PullRequestState!]
"""A list of label names to filter the pull requests by."""
labels: [String!]
"""The head ref name to filter the pull requests by."""
headRefName: String
"""The base ref name to filter the pull requests by."""
baseRefName: String
"""Ordering options for pull requests returned from the connection."""
orderBy: IssueOrder
"""
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
): PullRequestConnection!
id: ID!
"""The ref name."""
name: String!
"""The ref's prefix, such as `refs/heads/` or `refs/tags/`."""
prefix: String!
"""The repository the ref belongs to."""
repository: Repository!
"""The object the ref points to."""
target: GitObject!
}
"""The connection type for Ref."""
type RefConnection {
"""A list of edges."""
edges: [RefEdge]
"""A list of nodes."""
nodes: [Ref]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type RefEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Ref
}
"""Represents a 'referenced' event on a given `ReferencedSubject`."""
type ReferencedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the commit associated with the 'referenced' event."""
commit: Commit
"""Identifies the repository associated with the 'referenced' event."""
commitRepository: Repository!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""Reference originated in a different repository."""
isCrossRepository: Boolean!
"""
Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.
"""
isDirectReference: Boolean!
"""Object referenced by event."""
subject: ReferencedSubject!
}
"""Any referencable object"""
union ReferencedSubject = Issue | PullRequest
"""Ways in which lists of git refs can be ordered upon return."""
input RefOrder {
"""The field in which to order refs by."""
field: RefOrderField!
"""The direction in which to order refs by the specified field."""
direction: OrderDirection!
}
"""Properties by which ref connections can be ordered."""
enum RefOrderField {
"""Order refs by underlying commit date if the ref prefix is refs/tags/"""
TAG_COMMIT_DATE
"""Order refs by their alphanumeric name"""
ALPHABETICAL
}
"""Represents an owner of a registry package."""
interface RegistryPackageOwner {
id: ID!
}
"""Represents an interface to search packages on an object."""
interface RegistryPackageSearch {
id: ID!
}
"""A release contains the content for a release."""
type Release implements Node & UniformResourceLocatable {
"""The author of the release"""
author: User
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the description of the release."""
description: String
id: ID!
"""Whether or not the release is a draft"""
isDraft: Boolean!
"""Whether or not the release is a prerelease"""
isPrerelease: Boolean!
"""Identifies the title of the release."""
name: String
"""Identifies the date and time when the release was created."""
publishedAt: DateTime
"""List of releases assets which are dependent on this release."""
releaseAssets(
"""
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
"""A list of names to filter the assets by."""
name: String
): ReleaseAssetConnection!
"""The HTTP path for this issue"""
resourcePath: URI!
"""The Git tag the release points to"""
tag: Ref
"""The name of the release's Git tag"""
tagName: String!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this issue"""
url: URI!
}
"""A release asset contains the content for a release asset."""
type ReleaseAsset implements Node {
"""The asset's content-type"""
contentType: String!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""The number of times this asset was downloaded"""
downloadCount: Int!
"""
Identifies the URL where you can download the release asset via the browser.
"""
downloadUrl: URI!
id: ID!
"""Identifies the title of the release asset."""
name: String!
"""Release that the asset is associated with"""
release: Release
"""The size (in bytes) of the asset"""
size: Int!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The user that performed the upload"""
uploadedBy: User!
"""Identifies the URL of the release asset."""
url: URI!
}
"""The connection type for ReleaseAsset."""
type ReleaseAssetConnection {
"""A list of edges."""
edges: [ReleaseAssetEdge]
"""A list of nodes."""
nodes: [ReleaseAsset]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type ReleaseAssetEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: ReleaseAsset
}
"""The connection type for Release."""
type ReleaseConnection {
"""A list of edges."""
edges: [ReleaseEdge]
"""A list of nodes."""
nodes: [Release]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type ReleaseEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Release
}
"""Ways in which lists of releases can be ordered upon return."""
input ReleaseOrder {
"""The field in which to order releases by."""
field: ReleaseOrderField!
"""The direction in which to order releases by the specified field."""
direction: OrderDirection!
}
"""Properties by which release connections can be ordered."""
enum ReleaseOrderField {
"""Order releases by creation time"""
CREATED_AT
"""Order releases alphabetically by name"""
NAME
}
"""
Represents a 'removed_from_project' event on a given issue or pull request.
"""
type RemovedFromProjectEvent 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 RemoveOutsideCollaborator"""
input RemoveOutsideCollaboratorInput {
"""The ID of the outside collaborator to remove."""
userId: ID!
"""The ID of the organization to remove the outside collaborator from."""
organizationId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of RemoveOutsideCollaborator"""
type RemoveOutsideCollaboratorPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The user that was removed as an outside collaborator."""
removedUser: User
}
"""Autogenerated input type of RemoveReaction"""
input RemoveReactionInput {
"""The Node ID of the subject to modify."""
subjectId: ID!
"""The name of the emoji reaction to remove."""
content: ReactionContent!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of RemoveReaction"""
type RemoveReactionPayload {
"""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 RemoveStar"""
input RemoveStarInput {
"""The Starrable ID to unstar."""
starrableId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of RemoveStar"""
type RemoveStarPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The starrable."""
starrable: Starrable
}
"""Represents a 'renamed' event on a given issue or pull request"""
type RenamedTitleEvent 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 current title of the issue or pull request."""
currentTitle: String!
id: ID!
"""Identifies the previous title of the issue or pull request."""
previousTitle: String!
"""Subject that was renamed."""
subject: RenamedTitleSubject!
}
"""An object which has a renamable title"""
union RenamedTitleSubject = Issue | PullRequest
"""Represents a 'reopened' event on any `Closable`."""
type ReopenedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Object that was reopened."""
closable: Closable!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
}
"""The reasons a piece of content can be reported or minimized."""
enum ReportedContentClassifiers {
"""A spammy piece of content"""
SPAM
"""An abusive or harassing piece of content"""
ABUSE
"""An irrelevant piece of content"""
OFF_TOPIC
"""An outdated piece of content"""
OUTDATED
"""The content has been resolved"""
RESOLVED
}
"""A repository contains the content for a project."""
type Repository implements Node & ProjectOwner & RegistryPackageOwner & Subscribable & Starrable & UniformResourceLocatable & RepositoryInfo {
"""A list of users that can be assigned to issues in this repository."""
assignableUsers(
"""
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!
"""A list of branch protection rules for this repository."""
branchProtectionRules(
"""
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
): BranchProtectionRuleConnection!
"""Returns the code of conduct for this repository"""
codeOfConduct: CodeOfConduct
"""A list of collaborators associated with the repository."""
collaborators(
"""Collaborators affiliation level with a repository."""
affiliation: CollaboratorAffiliation
"""
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
): RepositoryCollaboratorConnection
"""A list of commit comments associated with the repository."""
commitComments(
"""
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!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
"""The Ref associated with the repository's default branch."""
defaultBranchRef: Ref
"""A list of deploy keys that are on this repository."""
deployKeys(
"""
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
): DeployKeyConnection!
"""Deployments associated with the repository"""
deployments(
"""
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
"""Environments to list deployments for"""
environments: [String!]
): DeploymentConnection!
"""The description of the repository."""
description: String
"""The description of the repository rendered to HTML."""
descriptionHTML: HTML!
"""The number of kilobytes this repository occupies on disk."""
diskUsage: Int
"""
Returns how many forks there are of this repository in the whole network.
"""
forkCount: Int!
"""A list of direct forked repositories."""
forks(
"""If non-null, filters repositories according to privacy"""
privacy: RepositoryPrivacy
"""Ordering options for repositories returned from the connection"""
orderBy: RepositoryOrder
"""
Array of viewer's affiliation options for repositories returned from the
connection. For example, OWNER will include only repositories that the
current viewer owns.
"""
affiliations: [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.
"""
ownerAffiliations: [RepositoryAffiliation]
"""
If non-null, filters repositories according to whether they have been locked
"""
isLocked: Boolean
"""
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
): RepositoryConnection!
"""Indicates if the repository has issues feature enabled."""
hasIssuesEnabled: Boolean!
"""Indicates if the repository has wiki feature enabled."""
hasWikiEnabled: Boolean!
"""The repository's URL."""
homepageUrl: URI
id: ID!
"""Indicates if the repository is unmaintained."""
isArchived: Boolean!
"""Identifies if the repository is a fork."""
isFork: Boolean!
"""Indicates if the repository has been locked or not."""
isLocked: Boolean!
"""Identifies if the repository is a mirror."""
isMirror: Boolean!
"""Identifies if the repository is private."""
isPrivate: Boolean!
"""Returns a single issue from the current repository by number."""
issue(
"""The number for the issue to be returned."""
number: Int!
): Issue
"""
Returns a single issue-like object from the current repository by number.
"""
issueOrPullRequest(
"""The number for the issue to be returned."""
number: Int!
): IssueOrPullRequest
"""A list of issues that have been opened in the repository."""
issues(
"""Ordering options for issues returned from the connection."""
orderBy: IssueOrder
"""A list of label names to filter the pull requests by."""
labels: [String!]
"""A list of states to filter the issues by."""
states: [IssueState!]
"""
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
): IssueConnection!
"""Returns a single label by name"""
label(
"""Label name"""
name: String!
): Label
"""A list of labels associated with the repository."""
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
"""If provided, searches labels by name and description."""
query: String
): LabelConnection
"""
A list containing a breakdown of the language composition of the repository.
"""
languages(
"""
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: LanguageOrder
): LanguageConnection
"""The license associated with the repository"""
licenseInfo: License
"""The reason the repository has been locked."""
lockReason: RepositoryLockReason
"""
A list of Users that can be mentioned in the context of the repository.
"""
mentionableUsers(
"""
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!
"""Whether or not PRs are merged with a merge commit on this repository."""
mergeCommitAllowed: Boolean!
"""Returns a single milestone from the current repository by number."""
milestone(
"""The number for the milestone to be returned."""
number: Int!
): Milestone
"""A list of milestones associated with the repository."""
milestones(
"""
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
"""Filter by the state of the milestones."""
states: [MilestoneState!]
"""Ordering options for milestones."""
orderBy: MilestoneOrder
): MilestoneConnection
"""The repository's original mirror URL."""
mirrorUrl: URI
"""The name of the repository."""
name: String!
"""The repository's name with owner."""
nameWithOwner: String!
"""A Git object in the repository"""
object(
"""The Git object ID"""
oid: GitObjectID
"""A Git revision expression suitable for rev-parse"""
expression: String
): GitObject
"""The User owner of the repository."""
owner: RepositoryOwner!
"""The repository parent, if this is a fork."""
parent: Repository
"""The primary language of the repository's code."""
primaryLanguage: Language
"""Find project by number."""
project(
"""The project number to find."""
number: Int!
): Project
"""A list of projects under the owner."""
projects(
"""Ordering options for projects returned from the connection"""
orderBy: ProjectOrder
"""Query to search projects by, currently only searching by name."""
search: String
"""A list of states to filter the projects by."""
states: [ProjectState!]
"""
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
): ProjectConnection!
"""The HTTP path listing the repository's projects"""
projectsResourcePath: URI!
"""The HTTP URL listing the repository's projects"""
projectsUrl: URI!
"""A list of protected branches that are on this repository."""
protectedBranches(
"""
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
): ProtectedBranchConnection! @deprecated(reason: "The `ProtectedBranch` type is deprecated and will be removed soon. Use `Repository.branchProtectionRules` instead. Removal on 2019-01-01 UTC.")
"""Returns a single pull request from the current repository by number."""
pullRequest(
"""The number for the pull request to be returned."""
number: Int!
): PullRequest
"""A list of pull requests that have been opened in the repository."""
pullRequests(
"""A list of states to filter the pull requests by."""
states: [PullRequestState!]
"""A list of label names to filter the pull requests by."""
labels: [String!]
"""The head ref name to filter the pull requests by."""
headRefName: String
"""The base ref name to filter the pull requests by."""
baseRefName: String
"""Ordering options for pull requests returned from the connection."""
orderBy: IssueOrder
"""
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
): PullRequestConnection!
"""Identifies when the repository was last pushed to."""
pushedAt: DateTime
"""Whether or not rebase-merging is enabled on this repository."""
rebaseMergeAllowed: Boolean!
"""Fetch a given ref from the repository"""
ref(
"""
The ref to retrieve. Fully qualified matches are checked in order
(`refs/heads/master`) before falling back onto checks for short name matches (`master`).
"""
qualifiedName: String!
): Ref
"""Fetch a list of refs from the repository"""
refs(
"""
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
"""A ref name prefix like `refs/heads/`, `refs/tags/`, etc."""
refPrefix: String!
"""DEPRECATED: use orderBy. The ordering direction."""
direction: OrderDirection
"""Ordering options for refs returned from the connection."""
orderBy: RefOrder
): RefConnection
"""Lookup a single release given various criteria."""
release(
"""The name of the Tag the Release was created from"""
tagName: String!
): Release
"""List of releases which are dependent on this repository."""
releases(
"""
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: ReleaseOrder
): ReleaseConnection!
"""A list of applied repository-topic associations for this repository."""
repositoryTopics(
"""
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
): RepositoryTopicConnection!
"""The HTTP path for this repository"""
resourcePath: URI!
"""
A description of the repository, rendered to HTML without any links in it.
"""
shortDescriptionHTML(
"""How many characters to return."""
limit: Int = 200
): HTML!
"""Whether or not squash-merging is enabled on this repository."""
squashMergeAllowed: Boolean!
"""The SSH URL to clone this repository"""
sshUrl: GitSSHRemote!
"""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!
"""The HTTP URL for this repository"""
url: URI!
"""
Indicates whether the viewer has admin permissions on this repository.
"""
viewerCanAdminister: Boolean!
"""Can the current viewer create new projects on this owner."""
viewerCanCreateProjects: Boolean!
"""
Check if the viewer is able to change their subscription status for the repository.
"""
viewerCanSubscribe: Boolean!
"""
Indicates whether the viewer can update the topics of this repository.
"""
viewerCanUpdateTopics: Boolean!
"""
Returns a boolean indicating whether the viewing user has starred this starrable.
"""
viewerHasStarred: Boolean!
"""
The users permission level on the repository. Will return null if authenticated as an GitHub App.
"""
viewerPermission: RepositoryPermission
"""
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
viewerSubscription: SubscriptionState
"""A list of users watching the repository."""
watchers(
"""
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 affiliation of a user to a repository"""
enum RepositoryAffiliation {
"""Repositories that are owned by the authenticated user."""
OWNER
"""Repositories that the user has been added to as a collaborator."""
COLLABORATOR
"""
Repositories that the user has access to through being a member of an
organization. This includes every repository on every team that the user is on.
"""
ORGANIZATION_MEMBER
}
"""The affiliation type between collaborator and repository."""
enum RepositoryCollaboratorAffiliation {
"""All collaborators of the repository."""
ALL
"""All outside collaborators of an organization-owned repository."""
OUTSIDE
}
"""The connection type for User."""
type RepositoryCollaboratorConnection {
"""A list of edges."""
edges: [RepositoryCollaboratorEdge]
"""A list of nodes."""
nodes: [User]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""Represents a user who is a collaborator of a repository."""
type RepositoryCollaboratorEdge {
"""A cursor for use in pagination."""
cursor: String!
node: User!
"""The permission the user has on the repository."""
permission: RepositoryPermission!
}
"""A list of repositories owned by the subject."""
type RepositoryConnection {
"""A list of edges."""
edges: [RepositoryEdge]
"""A list of nodes."""
nodes: [Repository]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
"""The total size in kilobytes of all repositories in the connection."""
totalDiskUsage: Int!
}
"""The reason a repository is listed as 'contributed'."""
enum RepositoryContributionType {
"""Created a commit"""
COMMIT
"""Created an issue"""
ISSUE
"""Created a pull request"""
PULL_REQUEST
"""Created the repository"""
REPOSITORY
"""Reviewed a pull request"""
PULL_REQUEST_REVIEW
}
"""An edge in a connection."""
type RepositoryEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: Repository
}
"""A subset of repository info."""
interface RepositoryInfo {
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""The description of the repository."""
description: String
"""The description of the repository rendered to HTML."""
descriptionHTML: HTML!
"""
Returns how many forks there are of this repository in the whole network.
"""
forkCount: Int!
"""Indicates if the repository has issues feature enabled."""
hasIssuesEnabled: Boolean!
"""Indicates if the repository has wiki feature enabled."""
hasWikiEnabled: Boolean!
"""The repository's URL."""
homepageUrl: URI
"""Indicates if the repository is unmaintained."""
isArchived: Boolean!
"""Identifies if the repository is a fork."""
isFork: Boolean!
"""Indicates if the repository has been locked or not."""
isLocked: Boolean!
"""Identifies if the repository is a mirror."""
isMirror: Boolean!
"""Identifies if the repository is private."""
isPrivate: Boolean!
"""The license associated with the repository"""
licenseInfo: License
"""The reason the repository has been locked."""
lockReason: RepositoryLockReason
"""The repository's original mirror URL."""
mirrorUrl: URI
"""The name of the repository."""
name: String!
"""The repository's name with owner."""
nameWithOwner: String!
"""The User owner of the repository."""
owner: RepositoryOwner!
"""Identifies when the repository was last pushed to."""
pushedAt: DateTime
"""The HTTP path for this repository"""
resourcePath: URI!
"""
A description of the repository, rendered to HTML without any links in it.
"""
shortDescriptionHTML(
"""How many characters to return."""
limit: Int = 200
): HTML!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this repository"""
url: URI!
}
"""An invitation for a user to be added to a repository."""
type RepositoryInvitation implements Node {
id: ID!
"""The user who received the invitation."""
invitee: User!
"""The user who created the invitation."""
inviter: User!
"""The permission granted on this repository by this invitation."""
permission: RepositoryPermission!
"""The Repository the user is invited to."""
repository: RepositoryInfo
}
"""An edge in a connection."""
type RepositoryInvitationEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: RepositoryInvitation
}
"""The possible reasons a given repository could be in a locked state."""
enum RepositoryLockReason {
"""The repository is locked due to a move."""
MOVING
"""The repository is locked due to a billing related reason."""
BILLING
"""The repository is locked due to a rename."""
RENAME
"""The repository is locked due to a migration."""
MIGRATING
}
"""Represents a object that belongs to a repository."""
interface RepositoryNode {
"""The repository associated with this node."""
repository: Repository!
}
"""Ordering options for repository connections"""
input RepositoryOrder {
"""The field to order repositories by."""
field: RepositoryOrderField!
"""The ordering direction."""
direction: OrderDirection!
}
"""Properties by which repository connections can be ordered."""
enum RepositoryOrderField {
"""Order repositories by creation time"""
CREATED_AT
"""Order repositories by update time"""
UPDATED_AT
"""Order repositories by push time"""
PUSHED_AT
"""Order repositories by name"""
NAME
"""Order repositories by number of stargazers"""
STARGAZERS
}
"""Represents an owner of a Repository."""
interface RepositoryOwner {
"""A URL pointing to the owner's public avatar."""
avatarUrl(
"""The size of the resulting square image."""
size: Int
): URI!
id: ID!
"""The username used to login."""
login: String!
"""A list of repositories this user has pinned to their profile"""
pinnedRepositories(
"""If non-null, filters repositories according to privacy"""
privacy: RepositoryPrivacy
"""Ordering options for repositories returned from the connection"""
orderBy: RepositoryOrder
"""
Array of viewer's affiliation options for repositories returned from the
connection. For example, OWNER will include only repositories that the
current viewer owns.
"""
affiliations: [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.
"""
ownerAffiliations: [RepositoryAffiliation]
"""
If non-null, filters repositories according to whether they have been locked
"""
isLocked: Boolean
"""
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
): RepositoryConnection!
"""A list of repositories that the user owns."""
repositories(
"""If non-null, filters repositories according to privacy"""
privacy: RepositoryPrivacy
"""Ordering options for repositories returned from the connection"""
orderBy: RepositoryOrder
"""
Array of viewer's affiliation options for repositories returned from the
connection. For example, OWNER will include only repositories that the
current viewer owns.
"""
affiliations: [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.
"""
ownerAffiliations: [RepositoryAffiliation]
"""
If non-null, filters repositories according to whether they have been locked
"""
isLocked: Boolean
"""
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 repositories according to whether they are forks of another repository
"""
isFork: Boolean
): RepositoryConnection!
"""Find Repository."""
repository(
"""Name of Repository to find."""
name: String!
): Repository
"""The HTTP URL for the owner."""
resourcePath: URI!
"""The HTTP URL for the owner."""
url: URI!
}
"""The access level to a repository"""
enum RepositoryPermission {
"""Can read, clone, push, and add collaborators"""
ADMIN
"""Can read, clone and push"""
WRITE
"""Can read and clone"""
READ
}
"""The privacy of a repository"""
enum RepositoryPrivacy {
"""Public"""
PUBLIC
"""Private"""
PRIVATE
}
"""A repository-topic connects a repository to a topic."""
type RepositoryTopic implements Node & UniformResourceLocatable {
id: ID!
"""The HTTP path for this repository-topic."""
resourcePath: URI!
"""The topic."""
topic: Topic!
"""The HTTP URL for this repository-topic."""
url: URI!
}
"""The connection type for RepositoryTopic."""
type RepositoryTopicConnection {
"""A list of edges."""
edges: [RepositoryTopicEdge]
"""A list of nodes."""
nodes: [RepositoryTopic]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type RepositoryTopicEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: RepositoryTopic
}
"""Types that can be requested reviewers."""
union RequestedReviewer = User | Team
"""Autogenerated input type of RequestReviews"""
input RequestReviewsInput {
"""The Node ID of the pull request to modify."""
pullRequestId: ID!
"""The Node IDs of the user to request."""
userIds: [ID!]
"""The Node IDs of the team to request."""
teamIds: [ID!]
"""Add users to the set rather than replace."""
union: Boolean
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of RequestReviews"""
type RequestReviewsPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The pull request that is getting requests."""
pullRequest: PullRequest
"""The edge from the pull request to the requested reviewers."""
requestedReviewersEdge: UserEdge
}
"""Autogenerated input type of ResolveReviewThread"""
input ResolveReviewThreadInput {
"""The ID of the thread to resolve"""
threadId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Represents a private contribution a user made on GitHub."""
type RestrictedContribution 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 HTTP path for this contribution."""
resourcePath: URI!
"""The HTTP URL for this contribution."""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""
A team or user who has the ability to dismiss a review on a protected branch.
"""
type ReviewDismissalAllowance implements Node {
"""The actor that can dismiss."""
actor: ReviewDismissalAllowanceActor
"""
Identifies the branch protection rule associated with the allowed user or team.
"""
branchProtectionRule: BranchProtectionRule
id: ID!
}
"""Types that can be an actor."""
union ReviewDismissalAllowanceActor = User | Team
"""The connection type for ReviewDismissalAllowance."""
type ReviewDismissalAllowanceConnection {
"""A list of edges."""
edges: [ReviewDismissalAllowanceEdge]
"""A list of nodes."""
nodes: [ReviewDismissalAllowance]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type ReviewDismissalAllowanceEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: ReviewDismissalAllowance
}
"""
Represents a 'review_dismissed' event on a given issue or pull request.
"""
type ReviewDismissedEvent implements Node & UniformResourceLocatable {
"""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!
"""Identifies the message associated with the 'review_dismissed' event."""
message: String!
"""The message associated with the event, rendered to HTML."""
messageHtml: HTML!
"""
Identifies the previous state of the review with the 'review_dismissed' event.
"""
previousReviewState: PullRequestReviewState!
"""PullRequest referenced by event."""
pullRequest: PullRequest!
"""Identifies the commit which caused the review to become stale."""
pullRequestCommit: PullRequestCommit
"""The HTTP path for this review dismissed event."""
resourcePath: URI!
"""Identifies the review associated with the 'review_dismissed' event."""
review: PullRequestReview
"""The HTTP URL for this review dismissed event."""
url: URI!
}
"""A request for a user to review a pull request."""
type ReviewRequest implements Node {
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
"""Identifies the pull request associated with this review request."""
pullRequest: PullRequest!
"""The reviewer that is requested."""
requestedReviewer: RequestedReviewer
}
"""The connection type for ReviewRequest."""
type ReviewRequestConnection {
"""A list of edges."""
edges: [ReviewRequestEdge]
"""A list of nodes."""
nodes: [ReviewRequest]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""Represents an 'review_requested' event on a given pull request."""
type ReviewRequestedEvent 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!
"""Identifies the reviewer whose review was requested."""
requestedReviewer: RequestedReviewer
}
"""An edge in a connection."""
type ReviewRequestEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: ReviewRequest
}
"""Represents an 'review_request_removed' event on a given pull request."""
type ReviewRequestRemovedEvent 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!
"""Identifies the reviewer whose review request was removed."""
requestedReviewer: RequestedReviewer
}
"""The results of a search."""
union SearchResultItem = Issue | PullRequest | Repository | User | Organization | MarketplaceListing
"""A list of results that matched against a search query."""
type SearchResultItemConnection {
"""The number of pieces of code that matched the search query."""
codeCount: Int!
"""A list of edges."""
edges: [SearchResultItemEdge]
"""The number of issues that matched the search query."""
issueCount: Int!
"""A list of nodes."""
nodes: [SearchResultItem]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""The number of repositories that matched the search query."""
repositoryCount: Int!
"""The number of users that matched the search query."""
userCount: Int!
"""The number of wiki pages that matched the search query."""
wikiCount: Int!
}
"""An edge in a connection."""
type SearchResultItemEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: SearchResultItem
"""Text matches on the result found."""
textMatches: [TextMatch]
}
"""Represents the individual results of a search."""
enum SearchType {
"""Returns results matching issues in repositories."""
ISSUE
"""Returns results matching repositories."""
REPOSITORY
"""Returns results matching users and organizations on GitHub."""
USER
}
"""Represents an S/MIME signature on a Commit or Tag."""
type SmimeSignature implements 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 connection type for User."""
type StargazerConnection {
"""A list of edges."""
edges: [StargazerEdge]
"""A list of nodes."""
nodes: [User]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""Represents a user that's starred a repository."""
type StargazerEdge {
"""A cursor for use in pagination."""
cursor: String!
node: User!
"""Identifies when the item was starred."""
starredAt: DateTime!
}
"""Ways in which star connections can be ordered."""
input StarOrder {
"""The field in which to order nodes by."""
field: StarOrderField!
"""The direction in which to order nodes."""
direction: OrderDirection!
}
"""Properties by which star connections can be ordered."""
enum StarOrderField {
"""Allows ordering a list of stars by when they were created."""
STARRED_AT
}
"""Things that can be starred."""
interface Starrable {
id: ID!
"""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!
"""
Returns a boolean indicating whether the viewing user has starred this starrable.
"""
viewerHasStarred: Boolean!
}
"""The connection type for Repository."""
type StarredRepositoryConnection {
"""A list of edges."""
edges: [StarredRepositoryEdge]
"""A list of nodes."""
nodes: [Repository]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""Represents a starred repository."""
type StarredRepositoryEdge {
"""A cursor for use in pagination."""
cursor: String!
node: Repository!
"""Identifies when the item was starred."""
starredAt: DateTime!
}
"""Represents a commit status."""
type Status implements Node {
"""The commit this status is attached to."""
commit: Commit
"""Looks up an individual status context by context name."""
context(
"""The context name."""
name: String!
): StatusContext
"""The individual status contexts for this commit."""
contexts: [StatusContext!]!
id: ID!
"""The combined commit status."""
state: StatusState!
}
"""Represents an individual commit status context"""
type StatusContext implements Node {
"""This commit this status context is attached to."""
commit: Commit
"""The name of this status context."""
context: String!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""The actor who created this status context."""
creator: Actor
"""The description for this status context."""
description: String
id: ID!
"""The state of this status context."""
state: StatusState!
"""The URL for this status context."""
targetUrl: URI
}
"""The possible commit status states."""
enum StatusState {
"""Status is expected."""
EXPECTED
"""Status is errored."""
ERROR
"""Status is failing."""
FAILURE
"""Status is pending."""
PENDING
"""Status is successful."""
SUCCESS
}
"""Autogenerated input type of SubmitPullRequestReview"""
input SubmitPullRequestReviewInput {
"""The Pull Request Review ID to submit."""
pullRequestReviewId: ID!
"""The event to send to the Pull Request Review."""
event: PullRequestReviewEvent!
"""The text field to set on the Pull Request Review."""
body: String
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of SubmitPullRequestReview"""
type SubmitPullRequestReviewPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""The submitted pull request review."""
pullRequestReview: PullRequestReview
}
"""Entities that can be subscribed to for web and email notifications."""
interface Subscribable {
id: ID!
"""
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
}
"""Represents a 'subscribed' event on a given `Subscribable`."""
type SubscribedEvent 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!
"""Object referenced by event."""
subscribable: Subscribable!
}
"""The possible states of a subscription."""
enum SubscriptionState {
"""The User is only notified when participating or @mentioned."""
UNSUBSCRIBED
"""The User is notified of all conversations."""
SUBSCRIBED
"""The User is never notified."""
IGNORED
}
"""
A suggestion to review a pull request based on a user's commit history and review comments.
"""
type SuggestedReviewer {
"""Is this suggestion based on past commits?"""
isAuthor: Boolean!
"""Is this suggestion based on past review comments?"""
isCommenter: Boolean!
"""Identifies the user suggested to review the pull request."""
reviewer: User!
}
"""Represents a Git tag."""
type Tag implements Node & 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 tag message."""
message: String
"""The Git tag name."""
name: String!
"""The Git object ID"""
oid: GitObjectID!
"""The Repository the Git object belongs to"""
repository: Repository!
"""Details about the tag author."""
tagger: GitActor
"""The Git object the tag points to."""
target: GitObject!
}
"""A team of users in an organization."""
type Team implements Node & Subscribable {
"""A list of teams that are ancestors of this team."""
ancestors(
"""
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
): TeamConnection!
"""A URL pointing to the team's avatar."""
avatarUrl(
"""The size in pixels of the resulting square image."""
size: Int = 400
): URI
"""List of child teams belonging to this team"""
childTeams(
"""Order for connection"""
orderBy: TeamOrder
"""User logins to filter by"""
userLogins: [String!]
"""Whether to list immediate child teams or all descendant child teams."""
immediateOnly: Boolean = true
"""
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
): TeamConnection!
"""The slug corresponding to the organization and team."""
combinedSlug: String!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""The description of the team."""
description: String
"""The HTTP path for editing this team"""
editTeamResourcePath: URI!
"""The HTTP URL for editing this team"""
editTeamUrl: URI!
id: ID!
"""A list of pending invitations for users to this team"""
invitations(
"""
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
): OrganizationInvitationConnection
"""A list of users who are members of this team."""
members(
"""
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
"""The search string to look for."""
query: String
"""Filter by membership type"""
membership: TeamMembershipType = ALL
"""Filter by team member role"""
role: TeamMemberRole
"""Order for the connection."""
orderBy: TeamMemberOrder
): TeamMemberConnection!
"""The HTTP path for the team' members"""
membersResourcePath: URI!
"""The HTTP URL for the team' members"""
membersUrl: URI!
"""The name of the team."""
name: String!
"""The HTTP path creating a new team"""
newTeamResourcePath: URI!
"""The HTTP URL creating a new team"""
newTeamUrl: URI!
"""The organization that owns this team."""
organization: Organization!
"""The parent team of the team."""
parentTeam: Team
"""The level of privacy the team has."""
privacy: TeamPrivacy!
"""A list of repositories this team has access to."""
repositories(
"""
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
"""The search string to look for."""
query: String
"""Order for the connection."""
orderBy: TeamRepositoryOrder
): TeamRepositoryConnection!
"""The HTTP path for this team's repositories"""
repositoriesResourcePath: URI!
"""The HTTP URL for this team's repositories"""
repositoriesUrl: URI!
""
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment