"""
Marks an element of a GraphQL schema as only available via a preview header
"""
directive @preview(
"""
The identifier of the API preview that toggles this field.
"""
toggledBy: String!
) on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | UNION
"""
Defines what type of global IDs are accepted for a mutation argument of type ID.
"""
directive @possibleTypes(
"""
Abstract type of accepted global ID
"""
abstractType: String
"""
Accepted types of global IDs.
"""
concreteTypes: [String!]!
) on INPUT_FIELD_DEFINITION
"""
Assigns a documentation category for docs.github.com, aligned with REST API reference sections.
"""
directive @docsCategory(
"""
The category slug (e.g. "issues", "pulls", "repos").
"""
name: String!
) on ENUM | FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | UNION
"""
Autogenerated input type of AbortQueuedMigrations
"""
input AbortQueuedMigrationsInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the organization that is running the migrations.
"""
ownerId: ID! @possibleTypes(concreteTypes: ["Organization"])
}
"""
Autogenerated return type of AbortQueuedMigrations.
"""
type AbortQueuedMigrationsPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Did the operation succeed?
"""
success: Boolean
}
"""
Autogenerated input type of AbortRepositoryMigration
"""
input AbortRepositoryMigrationInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the migration to be aborted.
"""
migrationId: ID! @possibleTypes(concreteTypes: ["RepositoryMigration"])
}
"""
Autogenerated return type of AbortRepositoryMigration.
"""
type AbortRepositoryMigrationPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Did the operation succeed?
"""
success: Boolean
}
"""
Autogenerated input type of AcceptEnterpriseAdministratorInvitation
"""
input AcceptEnterpriseAdministratorInvitationInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the invitation being accepted
"""
invitationId: ID! @possibleTypes(concreteTypes: ["EnterpriseAdministratorInvitation"])
}
"""
Autogenerated return type of AcceptEnterpriseAdministratorInvitation.
"""
type AcceptEnterpriseAdministratorInvitationPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The invitation that was accepted.
"""
invitation: EnterpriseAdministratorInvitation
"""
A message confirming the result of accepting an administrator invitation.
"""
message: String
}
"""
Autogenerated input type of AcceptEnterpriseMemberInvitation
"""
input AcceptEnterpriseMemberInvitationInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the invitation being accepted
"""
invitationId: ID! @possibleTypes(concreteTypes: ["EnterpriseMemberInvitation"])
}
"""
Autogenerated return type of AcceptEnterpriseMemberInvitation.
"""
type AcceptEnterpriseMemberInvitationPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The invitation that was accepted.
"""
invitation: EnterpriseMemberInvitation
"""
A message confirming the result of accepting an unaffiliated member invitation.
"""
message: String
}
"""
Autogenerated input type of AcceptTopicSuggestion
"""
input AcceptTopicSuggestionInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The name of the suggested topic.
**Upcoming Change on 2024-04-01 UTC**
**Description:** `name` will be removed.
**Reason:** Suggested topics are no longer supported
"""
name: String
"""
The Node ID of the repository.
**Upcoming Change on 2024-04-01 UTC**
**Description:** `repositoryId` will be removed.
**Reason:** Suggested topics are no longer supported
"""
repositoryId: ID @possibleTypes(concreteTypes: ["Repository"])
}
"""
Autogenerated return type of AcceptTopicSuggestion.
"""
type AcceptTopicSuggestionPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The accepted topic.
"""
topic: Topic @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
}
"""
Autogenerated input type of AccessUserNamespaceRepository
"""
input AccessUserNamespaceRepositoryInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the enterprise owning the user namespace repository.
"""
enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
The ID of the user namespace repository to access.
"""
repositoryId: ID!
}
"""
Autogenerated return type of AccessUserNamespaceRepository.
"""
type AccessUserNamespaceRepositoryPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The time that repository access expires at
"""
expiresAt: DateTime
"""
The repository that is temporarily accessible.
"""
repository: Repository
}
"""
Represents an object which can take actions on GitHub. Typically a User or Bot.
"""
interface Actor @docsCategory(name: "users") {
"""
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!
}
"""
The connection type for Actor.
"""
type ActorConnection {
"""
A list of edges.
"""
edges: [ActorEdge]
"""
A list of nodes.
"""
nodes: [Actor]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type ActorEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Actor
}
"""
Location information for an actor
"""
type ActorLocation @docsCategory(name: "users") {
"""
City
"""
city: String
"""
Country name
"""
country: String
"""
Country code
"""
countryCode: String
"""
Region name
"""
region: String
"""
Region or state code
"""
regionCode: String
}
"""
The actor's type.
"""
enum ActorType @docsCategory(name: "users") {
"""
Indicates a team actor.
"""
TEAM
"""
Indicates a user actor.
"""
USER
}
"""
Autogenerated input type of AddAssigneesToAssignable
"""
input AddAssigneesToAssignableInput {
"""
Configuration for assigning Copilot to this issue.
"""
agentAssignment: AgentAssignmentInput
"""
The id of the assignable object to add assignees to.
"""
assignableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Assignable")
"""
The ids of actors (users or bots) to add as assignees. Mutually exclusive with `assignees`.
"""
assigneeIds: [ID!]
@possibleTypes(
concreteTypes: ["Bot", "EnterpriseUserAccount", "Mannequin", "Organization", "User"]
abstractType: "Actor"
)
"""
An array of actors to add as assignees, each with optional rationale or
suggest flag. Mutually exclusive with `assigneeIds`.
"""
assignees: [AssigneeUpdateInput!]
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated return type of AddAssigneesToAssignable.
"""
type AddAssigneesToAssignablePayload {
"""
The item that was assigned.
"""
assignable: Assignable
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of AddBlockedBy
"""
input AddBlockedByInput {
"""
The ID of the issue that blocks the given issue.
"""
blockingIssueId: ID! @possibleTypes(concreteTypes: ["Issue"])
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the issue to be blocked.
"""
issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
}
"""
Autogenerated return type of AddBlockedBy.
"""
type AddBlockedByPayload {
"""
The issue that is blocking the given issue.
"""
blockingIssue: Issue
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The issue that is blocked.
"""
issue: Issue
}
"""
Autogenerated input type of AddCloseIssueReferences
"""
input AddCloseIssueReferencesInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
ID of the issue to add closing references to.
"""
issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
"""
IDs of the pull requests to link as closing references. Limit: 10.
"""
pullRequestIds: [ID!]! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
Autogenerated return type of AddCloseIssueReferences.
"""
type AddCloseIssueReferencesPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The issue the closing references were added to.
"""
issue: Issue
}
"""
Autogenerated input type of AddComment
"""
input AddCommentInput {
"""
The contents of the comment.
"""
body: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the subject to modify.
"""
subjectId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest")
}
"""
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
}
"""
Autogenerated input type of AddDiscussionComment
"""
input AddDiscussionCommentInput {
"""
The contents of the comment.
"""
body: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the discussion to comment on.
"""
discussionId: ID! @possibleTypes(concreteTypes: ["Discussion"])
"""
The Node ID of the discussion comment within this discussion to reply to.
"""
replyToId: ID @possibleTypes(concreteTypes: ["DiscussionComment"])
}
"""
Autogenerated return type of AddDiscussionComment.
"""
type AddDiscussionCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The newly created discussion comment.
"""
comment: DiscussionComment
}
"""
Autogenerated input type of AddDiscussionPollVote
"""
input AddDiscussionPollVoteInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the discussion poll option to vote for.
"""
pollOptionId: ID! @possibleTypes(concreteTypes: ["DiscussionPollOption"])
}
"""
Autogenerated return type of AddDiscussionPollVote.
"""
type AddDiscussionPollVotePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The poll option that a vote was added to.
"""
pollOption: DiscussionPollOption
}
"""
Autogenerated input type of AddEnterpriseOrganizationMember
"""
input AddEnterpriseOrganizationMemberInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the enterprise which owns the organization.
"""
enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
The ID of the organization the users will be added to.
"""
organizationId: ID! @possibleTypes(concreteTypes: ["Organization"])
"""
The role to assign the users in the organization
"""
role: OrganizationMemberRole
"""
The IDs of the enterprise members to add.
"""
userIds: [ID!]!
}
"""
Autogenerated return type of AddEnterpriseOrganizationMember.
"""
type AddEnterpriseOrganizationMemberPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The users who were added to the organization.
"""
users: [User!]
}
"""
Autogenerated input type of AddEnterpriseSupportEntitlement
"""
input AddEnterpriseSupportEntitlementInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the Enterprise which the admin belongs to.
"""
enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
The login of a member who will receive the support entitlement.
"""
login: String!
}
"""
Autogenerated return type of AddEnterpriseSupportEntitlement.
"""
type AddEnterpriseSupportEntitlementPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A message confirming the result of adding the support entitlement.
"""
message: String
}
"""
Autogenerated input type of AddLabelsToLabelable
"""
input AddLabelsToLabelableInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ids of the labels to add.
"""
labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"])
"""
The id of the labelable object to add labels to.
"""
labelableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Labelable")
"""
The labels to add, each with optional `rationale` or a `suggest` flag that
stores the addition as a pending suggestion. Mutually exclusive with `labelIds`.
"""
labels: [LabelUpdateInput!]
}
"""
Autogenerated return type of AddLabelsToLabelable.
"""
type AddLabelsToLabelablePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item that was labeled.
"""
labelable: Labelable
}
"""
Autogenerated input type of AddProjectCard
"""
input AddProjectCardInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The content of the card. Must be a member of the ProjectCardItem union
"""
contentId: ID @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "ProjectCardItem")
"""
The note on the card.
"""
note: String
"""
The Node ID of the ProjectColumn.
"""
projectColumnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
}
"""
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 {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The name of the column.
"""
name: String!
"""
The Node ID of the project.
"""
projectId: ID! @possibleTypes(concreteTypes: ["Project"])
}
"""
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 AddProjectV2DraftIssue
"""
input AddProjectV2DraftIssueInput {
"""
The IDs of the assignees of the draft issue.
"""
assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"])
"""
The body of the draft issue.
"""
body: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the Project to add the draft issue to.
"""
projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"])
"""
The title of the draft issue. A project item can also be created by providing
the URL of an Issue or Pull Request if you have access.
"""
title: String!
}
"""
Autogenerated return type of AddProjectV2DraftIssue.
"""
type AddProjectV2DraftIssuePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The draft issue added to the project.
"""
projectItem: ProjectV2Item
}
"""
Autogenerated input type of AddProjectV2ItemById
"""
input AddProjectV2ItemByIdInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the Issue or Pull Request to add.
"""
contentId: ID!
@possibleTypes(concreteTypes: ["DraftIssue", "Issue", "PullRequest"], abstractType: "ProjectV2ItemContent")
"""
The ID of the Project to add the item to.
"""
projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"])
}
"""
Autogenerated return type of AddProjectV2ItemById.
"""
type AddProjectV2ItemByIdPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item added to the project.
"""
item: ProjectV2Item
}
"""
Autogenerated input type of AddPullRequestCreationCapBypassUsers
"""
input AddPullRequestCreationCapBypassUsersInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
"""
The Node IDs of the users to add to the bypass list.
"""
userIds: [ID!]! @possibleTypes(concreteTypes: ["User"])
}
"""
Autogenerated return type of AddPullRequestCreationCapBypassUsers.
"""
type AddPullRequestCreationCapBypassUsersPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The repository with the updated bypass list.
"""
repository: Repository
}
"""
Autogenerated input type of AddPullRequestReviewComment
"""
input AddPullRequestReviewCommentInput {
"""
The text of the comment. This field is required
**Upcoming Change on 2023-10-01 UTC**
**Description:** `body` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead
**Reason:** We are deprecating the addPullRequestReviewComment mutation
"""
body: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The SHA of the commit to comment on.
**Upcoming Change on 2023-10-01 UTC**
**Description:** `commitOID` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead
**Reason:** We are deprecating the addPullRequestReviewComment mutation
"""
commitOID: GitObjectID
"""
The comment id to reply to.
**Upcoming Change on 2023-10-01 UTC**
**Description:** `inReplyTo` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead
**Reason:** We are deprecating the addPullRequestReviewComment mutation
"""
inReplyTo: ID @possibleTypes(concreteTypes: ["PullRequestReviewComment"])
"""
The relative path of the file to comment on.
**Upcoming Change on 2023-10-01 UTC**
**Description:** `path` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead
**Reason:** We are deprecating the addPullRequestReviewComment mutation
"""
path: String
"""
The line index in the diff to comment on.
**Upcoming Change on 2023-10-01 UTC**
**Description:** `position` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead
**Reason:** We are deprecating the addPullRequestReviewComment mutation
"""
position: Int
"""
The node ID of the pull request reviewing
**Upcoming Change on 2023-10-01 UTC**
**Description:** `pullRequestId` will be removed. use
addPullRequestReviewThread or addPullRequestReviewThreadReply instead
**Reason:** We are deprecating the addPullRequestReviewComment mutation
"""
pullRequestId: ID @possibleTypes(concreteTypes: ["PullRequest"])
"""
The Node ID of the review to modify.
**Upcoming Change on 2023-10-01 UTC**
**Description:** `pullRequestReviewId` will be removed. use
addPullRequestReviewThread or addPullRequestReviewThreadReply instead
**Reason:** We are deprecating the addPullRequestReviewComment mutation
"""
pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
}
"""
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 contents of the review body comment.
"""
body: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The review line comments.
**Upcoming Change on 2023-10-01 UTC**
**Description:** `comments` will be removed. use the `threads` argument instead
**Reason:** We are deprecating comment fields that use diff-relative positioning
"""
comments: [DraftPullRequestReviewComment]
"""
The commit OID the review pertains to.
"""
commitOID: GitObjectID
"""
The event to perform on the pull request review.
"""
event: PullRequestReviewEvent
"""
The Node ID of the pull request to modify.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
"""
The review line comment threads.
"""
threads: [DraftPullRequestReviewThread]
}
"""
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 AddPullRequestReviewThread
"""
input AddPullRequestReviewThreadInput {
"""
Body of the thread's first comment.
"""
body: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The line of the blob to which the thread refers, required for line-level
threads. The end of the line range for multi-line comments.
"""
line: Int
"""
Path to the file being commented on.
"""
path: String
"""
The node ID of the pull request reviewing
"""
pullRequestId: ID @possibleTypes(concreteTypes: ["PullRequest"])
"""
The Node ID of the review to modify.
"""
pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
"""
The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.
"""
side: DiffSide = RIGHT
"""
The first line of the range to which the comment refers.
"""
startLine: Int
"""
The side of the diff on which the start line resides.
"""
startSide: DiffSide = RIGHT
"""
The level at which the comments in the corresponding thread are targeted, can be a diff line or a file
"""
subjectType: PullRequestReviewThreadSubjectType = LINE
}
"""
Autogenerated return type of AddPullRequestReviewThread.
"""
type AddPullRequestReviewThreadPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The newly created thread.
"""
thread: PullRequestReviewThread
}
"""
Autogenerated input type of AddPullRequestReviewThreadReply
"""
input AddPullRequestReviewThreadReplyInput {
"""
The text of the reply.
"""
body: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the pending review to which the reply will belong.
"""
pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
"""
The Node ID of the thread to which this reply is being written.
"""
pullRequestReviewThreadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
}
"""
Autogenerated return type of AddPullRequestReviewThreadReply.
"""
type AddPullRequestReviewThreadReplyPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The newly created reply.
"""
comment: PullRequestReviewComment
}
"""
Autogenerated input type of AddReaction
"""
input AddReactionInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The name of the emoji to react with.
"""
content: ReactionContent!
"""
The Node ID of the subject to modify.
"""
subjectId: ID!
@possibleTypes(
concreteTypes: [
"CommitComment"
"Discussion"
"DiscussionComment"
"Issue"
"IssueComment"
"PullRequest"
"PullRequestReview"
"PullRequestReviewComment"
"Release"
]
abstractType: "Reactable"
)
}
"""
Autogenerated return type of AddReaction.
"""
type AddReactionPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The reaction object.
"""
reaction: Reaction
"""
The reaction groups for the subject.
"""
reactionGroups: [ReactionGroup!]
"""
The reactable subject.
"""
subject: Reactable
}
"""
Autogenerated input type of AddRelatesTo
"""
input AddRelatesToInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the issue.
"""
issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
"""
The ID of the related issue.
"""
relatedIssueId: ID! @possibleTypes(concreteTypes: ["Issue"])
}
"""
Autogenerated return type of AddRelatesTo.
"""
type AddRelatesToPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The source issue.
"""
issue: Issue
"""
The related issue.
"""
relatedIssue: Issue
}
"""
Autogenerated input type of AddStar
"""
input AddStarInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Starrable ID to star.
"""
starrableId: ID! @possibleTypes(concreteTypes: ["Gist", "Repository", "Topic"], abstractType: "Starrable")
}
"""
Autogenerated return type of AddStar.
"""
type AddStarPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The starrable.
"""
starrable: Starrable
}
"""
Autogenerated input type of AddSubIssue
"""
input AddSubIssueInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the issue.
"""
issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
"""
Option to replace parent issue if one already exists
"""
replaceParent: Boolean
"""
The id of the sub-issue.
"""
subIssueId: ID @possibleTypes(concreteTypes: ["Issue"])
"""
The url of the sub-issue.
"""
subIssueUrl: String
}
"""
Autogenerated return type of AddSubIssue.
"""
type AddSubIssuePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The parent issue that the sub-issue was added to.
"""
issue: Issue
"""
The sub-issue of the parent.
"""
subIssue: Issue
}
"""
Autogenerated input type of AddUpvote
"""
input AddUpvoteInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the discussion or comment to upvote.
"""
subjectId: ID! @possibleTypes(concreteTypes: ["Discussion", "DiscussionComment"], abstractType: "Votable")
}
"""
Autogenerated return type of AddUpvote.
"""
type AddUpvotePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The votable subject.
"""
subject: Votable
}
"""
Autogenerated input type of AddVerifiableDomain
"""
input AddVerifiableDomainInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The URL of the domain
"""
domain: URI!
"""
The ID of the owner to add the domain to
"""
ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "VerifiableDomainOwner")
}
"""
Autogenerated return type of AddVerifiableDomain.
"""
type AddVerifiableDomainPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The verifiable domain that was added.
"""
domain: VerifiableDomain
}
"""
Represents an 'added_to_merge_queue' event on a given pull request.
"""
type AddedToMergeQueueEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The user who added this Pull Request to the merge queue
"""
enqueuer: User
"""
The Node ID of the AddedToMergeQueueEvent object
"""
id: ID!
"""
The merge queue where this pull request was added to.
"""
mergeQueue: MergeQueue
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest
}
"""
Represents a 'added_to_project' event on a given issue or pull request.
"""
type AddedToProjectEvent implements Node @docsCategory(name: "projects-classic") {
"""
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
@deprecated(
reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC."
)
"""
The Node ID of the AddedToProjectEvent object
"""
id: ID!
"""
Project referenced by event.
"""
project: Project
@deprecated(
reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC."
)
"""
Project card referenced by this project event.
"""
projectCard: ProjectCard
@deprecated(
reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC."
)
"""
Column name referenced by this project event.
"""
projectColumnName: String!
@deprecated(
reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC."
)
}
"""
Represents a 'added_to_project_v2' event on a given issue or pull request.
"""
type AddedToProjectV2Event implements Node & ProjectV2Event @docsCategory(name: "projects") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the AddedToProjectV2Event object
"""
id: ID!
"""
Project referenced by event.
"""
project: ProjectV2
"""
Did this event result from workflow automation?
"""
wasAutomated: Boolean!
}
"""
Represents an 'added_to_stack' event on a given pull request.
"""
type AddedToStackEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the AddedToStackEvent object
"""
id: ID!
"""
Pull request added to the stack.
"""
pullRequest: PullRequest
"""
Database ID of the stack.
"""
stackId: BigInt
"""
Number of the stack in its repository.
"""
stackNumber: Int
}
"""
Represents configuration for assigning Copilot to an issue (public variant)
"""
input AgentAssignmentInput @docsCategory(name: "users") {
"""
The base ref/branch for the repository. Defaults to the default branch if not provided.
"""
baseRef: String
"""
Custom agent for Copilot.
"""
customAgent: String
"""
Custom instructions for Copilot.
"""
customInstructions: String
"""
The Node ID of the target repository where Copilot should work. Defaults to the issue's repository if not provided.
"""
targetRepositoryId: ID @possibleTypes(concreteTypes: ["Repository"])
}
"""
Copilot Agentic fields in context of the current viewer.
"""
interface Agentic @docsCategory(name: "copilot") {
"""
Channel value for subscribing to live updates for session creations.
"""
viewerCopilotAgentCreatesChannel: String
"""
Channel value for subscribing to live updates for session log updates.
"""
viewerCopilotAgentLogUpdatesChannel: String
"""
Channel value for subscribing to live updates for task updates.
"""
viewerCopilotAgentTaskUpdatesChannel: String
"""
Channel value for subscribing to live updates for session updates.
"""
viewerCopilotAgentUpdatesChannel: String
}
"""
An announcement banner for an enterprise or organization.
"""
type AnnouncementBanner @docsCategory(name: "enterprise-admin") {
"""
The date the announcement was created
"""
createdAt: DateTime!
"""
The expiration date of the announcement, if any
"""
expiresAt: DateTime
"""
Whether the announcement can be dismissed by the user
"""
isUserDismissible: Boolean!
"""
The text of the announcement
"""
message: String
}
"""
A GitHub App.
"""
type App implements Node @docsCategory(name: "apps") {
"""
The client ID of the app.
"""
clientId: String
"""
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
"""
The Node ID of the App object
"""
id: ID!
"""
The IP addresses of the app.
"""
ipAllowListEntries(
"""
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
"""
Ordering options for IP allow list entries returned.
"""
orderBy: IpAllowListEntryOrder = {field: ALLOW_LIST_VALUE, direction: ASC}
): IpAllowListEntryConnection!
"""
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!
}
"""
Autogenerated input type of ApplyPendingIssueSuggestions
"""
input ApplyPendingIssueSuggestionsInput {
"""
The ID of the actor whose suggestions to apply.
"""
actorId: ID!
@possibleTypes(
concreteTypes: ["Bot", "EnterpriseUserAccount", "Mannequin", "Organization", "User"]
abstractType: "Actor"
)
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the issue the suggestions apply to.
"""
issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
"""
The pending suggestions to apply.
"""
suggestions: [PendingIssueSuggestionRef!]!
}
"""
Autogenerated return type of ApplyPendingIssueSuggestions.
"""
type ApplyPendingIssueSuggestionsPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The updated issue.
"""
issue: Issue
}
"""
Autogenerated input type of ApproveDeployments
"""
input ApproveDeploymentsInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Optional comment for approving deployments
"""
comment: String = ""
"""
The ids of environments to reject deployments
"""
environmentIds: [ID!]!
"""
The node ID of the workflow run containing the pending deployments.
"""
workflowRunId: ID! @possibleTypes(concreteTypes: ["WorkflowRun"])
}
"""
Autogenerated return type of ApproveDeployments.
"""
type ApproveDeploymentsPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The affected deployments.
"""
deployments: [Deployment!]
}
"""
Autogenerated input type of ApproveVerifiableDomain
"""
input ApproveVerifiableDomainInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the verifiable domain to approve.
"""
id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"])
}
"""
Autogenerated return type of ApproveVerifiableDomain.
"""
type ApproveVerifiableDomainPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The verifiable domain that was approved.
"""
domain: VerifiableDomain
}
"""
Autogenerated input type of ArchiveProjectV2Item
"""
input ArchiveProjectV2ItemInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the ProjectV2Item to archive.
"""
itemId: ID! @possibleTypes(concreteTypes: ["ProjectV2Item"])
"""
The ID of the Project to archive the item from.
"""
projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"])
}
"""
Autogenerated return type of ArchiveProjectV2Item.
"""
type ArchiveProjectV2ItemPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item archived from the project.
"""
item: ProjectV2Item
}
"""
Autogenerated input type of ArchivePullRequest
"""
input ArchivePullRequestInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the pull request to archive.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
Autogenerated return type of ArchivePullRequest.
"""
type ArchivePullRequestPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The pull request that was archived.
"""
pullRequest: PullRequest
}
"""
Autogenerated input type of ArchiveRepository
"""
input ArchiveRepositoryInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the repository to mark as archived.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
Autogenerated return type of ArchiveRepository.
"""
type ArchiveRepositoryPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The repository that was marked as archived.
"""
repository: Repository
}
"""
An object that can have users assigned to it.
"""
interface Assignable @docsCategory(name: "issues") {
"""
A list of actors assigned to this object.
"""
assignedActors(
"""
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
): AssigneeConnection!
"""
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!
"""
A list of suggested actors to assign to this object
"""
suggestedActors(
"""
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 users by login or profile name
"""
query: String
): AssigneeConnection!
"""
Indicates if the viewer can edit assignees for this object.
"""
viewerCanAssign: Boolean!
}
"""
Represents an 'assigned' event on any assignable object.
"""
type AssignedEvent implements Node @docsCategory(name: "issues") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the assignable associated with the event.
"""
assignable: Assignable!
"""
Identifies the user or mannequin that was assigned.
"""
assignee: Assignee
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the AssignedEvent object
"""
id: ID!
"""
The intent behind the agent's action, including rationale and confidence.
"""
intent: IssueUpdateIntent
"""
Identifies the user who was assigned.
"""
user: User
@deprecated(reason: "Assignees can now be mannequins. Use the `assignee` field instead. Removal on 2020-01-01 UTC.")
}
"""
Types that can be assigned to issues.
"""
union Assignee @docsCategory(name: "issues") = Bot | Mannequin | Organization | User
"""
The connection type for Assignee.
"""
type AssigneeConnection {
"""
A list of edges.
"""
edges: [AssigneeEdge]
"""
A list of nodes.
"""
nodes: [Assignee]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type AssigneeEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Assignee
}
"""
Specifies an actor (user or bot) to assign to an issue, with optional metadata such as a rationale.
"""
input AssigneeUpdateInput @docsCategory(name: "issues") {
"""
The ID of the actor (user or bot) to assign.
"""
actorId: ID!
@possibleTypes(
concreteTypes: ["Bot", "EnterpriseUserAccount", "Mannequin", "Organization", "User"]
abstractType: "Actor"
)
"""
The confidence level the agent had when selecting this value.
"""
confidence: IssueEventConfidenceLevel
"""
Optional rationale describing why this value was selected. Max 280 characters.
"""
rationale: String
"""
If true, the value is stored as a pending suggestion for human review rather than being applied directly.
"""
suggest: Boolean
}
"""
An entry in the audit log.
"""
interface AuditEntry @docsCategory(name: "enterprise-admin") {
"""
The action name
"""
action: String!
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The user who initiated the action
"""
actor: AuditEntryActor
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The IP address of the actor
"""
actorIp: String
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
A readable representation of the actor's location
"""
actorLocation: ActorLocation
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The username of the user who initiated the action
"""
actorLogin: String
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The HTTP path for the actor.
"""
actorResourcePath: URI
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The HTTP URL for the actor.
"""
actorUrl: URI
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The time the action was initiated
"""
createdAt: PreciseDateTime!
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The corresponding operation type for the action
"""
operationType: OperationType
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The user affected by the action
"""
user: User
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
For actions involving two users, the actor is the initiator and the user is the affected user.
"""
userLogin: String
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The HTTP path for the user.
"""
userResourcePath: URI
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
"""
The HTTP URL for the user.
"""
userUrl: URI
@deprecated(
reason: "The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC."
)
}
"""
Types that can initiate an audit log event.
"""
union AuditEntryActor @docsCategory(name: "enterprise-admin") = Bot | Organization | User
"""
Ordering options for Audit Log connections.
"""
input AuditLogOrder @docsCategory(name: "enterprise-admin") {
"""
The ordering direction.
"""
direction: OrderDirection
"""
The field to order Audit Logs by.
"""
field: AuditLogOrderField
}
"""
Properties by which Audit Log connections can be ordered.
"""
enum AuditLogOrderField @docsCategory(name: "enterprise-admin") {
"""
Order audit log entries by timestamp
"""
CREATED_AT
}
"""
Represents a 'auto_merge_disabled' event on a given pull request.
"""
type AutoMergeDisabledEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The user who disabled auto-merge for this Pull Request
"""
disabler: User
"""
The Node ID of the AutoMergeDisabledEvent object
"""
id: ID!
"""
PullRequest referenced by event
"""
pullRequest: PullRequest
"""
The reason auto-merge was disabled
"""
reason: String
"""
The reason_code relating to why auto-merge was disabled
"""
reasonCode: String
}
"""
Represents a 'auto_merge_enabled' event on a given pull request.
"""
type AutoMergeEnabledEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The user who enabled auto-merge for this Pull Request
"""
enabler: User
"""
The Node ID of the AutoMergeEnabledEvent object
"""
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest
}
"""
Represents an auto-merge request for a pull request
"""
type AutoMergeRequest @docsCategory(name: "pulls") {
"""
The email address of the author of this auto-merge request.
"""
authorEmail: String
"""
The commit message of the auto-merge request. If a merge queue is required by
the base branch, this value will be set by the merge queue when merging.
"""
commitBody: String
"""
The commit title of the auto-merge request. If a merge queue is required by
the base branch, this value will be set by the merge queue when merging
"""
commitHeadline: String
"""
When was this auto-merge request was enabled.
"""
enabledAt: DateTime
"""
The actor who created the auto-merge request.
"""
enabledBy: Actor
"""
The merge method of the auto-merge request. If a merge queue is required by
the base branch, this value will be set by the merge queue when merging.
"""
mergeMethod: PullRequestMergeMethod!
"""
The pull request that this auto-merge request is set against.
"""
pullRequest: PullRequest!
}
"""
Represents a 'auto_rebase_enabled' event on a given pull request.
"""
type AutoRebaseEnabledEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The user who enabled auto-merge (rebase) for this Pull Request
"""
enabler: User
"""
The Node ID of the AutoRebaseEnabledEvent object
"""
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest
}
"""
Represents a 'auto_squash_enabled' event on a given pull request.
"""
type AutoSquashEnabledEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The user who enabled auto-merge (squash) for this Pull Request
"""
enabler: User
"""
The Node ID of the AutoSquashEnabledEvent object
"""
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest
}
"""
Represents a 'automatic_base_change_failed' event on a given pull request.
"""
type AutomaticBaseChangeFailedEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the AutomaticBaseChangeFailedEvent object
"""
id: ID!
"""
The new base for this PR
"""
newBase: String!
"""
The old base for this PR
"""
oldBase: String!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
}
"""
Represents a 'automatic_base_change_succeeded' event on a given pull request.
"""
type AutomaticBaseChangeSucceededEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the AutomaticBaseChangeSucceededEvent object
"""
id: ID!
"""
The new base for this PR
"""
newBase: String!
"""
The old base for this PR
"""
oldBase: String!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
}
"""
A (potentially binary) string encoded using base64.
"""
scalar Base64String
"""
Represents a 'base_ref_changed' event on a given issue or pull request.
"""
type BaseRefChangedEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the name of the base ref for the pull request after it was changed.
"""
currentRefName: String!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The Node ID of the BaseRefChangedEvent object
"""
id: ID!
"""
Identifies the name of the base ref for the pull request before it was changed.
"""
previousRefName: String!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
}
"""
Represents a 'base_ref_deleted' event on a given pull request.
"""
type BaseRefDeletedEvent implements Node @docsCategory(name: "pulls") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the name of the Ref associated with the `base_ref_deleted` event.
"""
baseRefName: String
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the BaseRefDeletedEvent object
"""
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest
}
"""
Represents a 'base_ref_force_pushed' event on a given pull request.
"""
type BaseRefForcePushedEvent implements Node @docsCategory(name: "pulls") {
"""
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!
"""
The Node ID of the BaseRefForcePushedEvent object
"""
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
"""
Identifies the fully qualified ref name for the 'base_ref_force_pushed' event.
"""
ref: Ref
}
"""
Represents non-fractional signed whole numeric values. Since the value may
exceed the size of a 32-bit integer, it's encoded as a string.
"""
scalar BigInt
"""
Represents a Git blame.
"""
type Blame @docsCategory(name: "git") {
"""
The list of ranges from a Git blame.
"""
ranges: [BlameRange!]!
}
"""
Represents a range of information from a Git blame.
"""
type BlameRange @docsCategory(name: "git") {
"""
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 GitObject & Node @docsCategory(name: "git") {
"""
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!
"""
The Node ID of the Blob object
"""
id: ID!
"""
Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.
"""
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
}
"""
Represents a 'blocked_by_added' event on a given issue.
"""
type BlockedByAddedEvent implements Node @docsCategory(name: "issues") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
The blocking issue that was added.
"""
blockingIssue: Issue
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the BlockedByAddedEvent object
"""
id: ID!
}
"""
Represents a 'blocked_by_removed' event on a given issue.
"""
type BlockedByRemovedEvent implements Node @docsCategory(name: "issues") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
The blocking issue that was removed.
"""
blockingIssue: Issue
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the BlockedByRemovedEvent object
"""
id: ID!
}
"""
Represents a 'blocking_added' event on a given issue.
"""
type BlockingAddedEvent implements Node @docsCategory(name: "issues") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
The blocked issue that was added.
"""
blockedIssue: Issue
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the BlockingAddedEvent object
"""
id: ID!
}
"""
Represents a 'blocking_removed' event on a given issue.
"""
type BlockingRemovedEvent implements Node @docsCategory(name: "issues") {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
The blocked issue that was removed.
"""
blockedIssue: Issue
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The Node ID of the BlockingRemovedEvent object
"""
id: ID!
}
"""
A special type of user which takes actions on behalf of GitHub Apps.
"""
type Bot implements Actor & Node & UniformResourceLocatable @docsCategory(name: "apps") {
"""
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
"""
The Node ID of the Bot object
"""
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!
}
"""
Types which can be actors for `BranchActorAllowance` objects.
"""
union BranchActorAllowanceActor @docsCategory(name: "branches") = App | Team | User
"""
Parameters to be used for the branch_name_pattern rule
"""
type BranchNamePatternParameters @docsCategory(name: "branches") {
"""
How this rule appears when configuring it.
"""
name: String
"""
If true, the rule will fail if the pattern matches.
"""
negate: Boolean!
"""
The operator to use for matching.
"""
operator: String!
"""
The pattern to match with.
"""
pattern: String!
}
"""
Parameters to be used for the branch_name_pattern rule
"""
input BranchNamePatternParametersInput @docsCategory(name: "branches") {
"""
How this rule appears when configuring it.
"""
name: String
"""
If true, the rule will fail if the pattern matches.
"""
negate: Boolean
"""
The operator to use for matching.
"""
operator: String!
"""
The pattern to match with.
"""
pattern: String!
}
"""
A branch protection rule.
"""
type BranchProtectionRule implements Node @docsCategory(name: "branches") {
"""
Can this branch be deleted.
"""
allowsDeletions: Boolean!
"""
Are force pushes allowed on this branch.
"""
allowsForcePushes: Boolean!
"""
Is branch creation a protected operation.
"""
blocksCreations: Boolean!
"""
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!
"""
A list of actors able to force push for this branch protection rule.
"""
bypassForcePushAllowances(
"""
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
): BypassForcePushAllowanceConnection!
"""
A list of actors able to bypass PRs for this branch protection rule.
"""
bypassPullRequestAllowances(
"""
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
): BypassPullRequestAllowanceConnection!
"""
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!
"""
The Node ID of the BranchProtectionRule object
"""
id: ID!
"""
Can admins override branch protection.
"""
isAdminEnforced: Boolean!
"""
Whether users can pull changes from upstream when the branch is locked. Set to
`true` to allow fork syncing. Set to `false` to prevent fork syncing.
"""
lockAllowsFetchAndMerge: Boolean!
"""
Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
"""
lockBranch: 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
"""
Filters refs with query on name
"""
query: String
): 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
"""
Whether the most recent push must be approved by someone other than the person who pushed it
"""
requireLastPushApproval: Boolean!
"""
Number of approving reviews required to update matching branches.
"""
requiredApprovingReviewCount: Int
"""
List of required deployment environments that must be deployed successfully to update matching branches
"""
requiredDeploymentEnvironments: [String]
"""
List of required status check contexts that must pass for commits to be accepted to matching branches.
"""
requiredStatusCheckContexts: [String]
"""
List of required status checks that must pass for commits to be accepted to matching branches.
"""
requiredStatusChecks: [RequiredStatusCheckDescription!]
"""
Are approving reviews required to update matching branches.
"""
requiresApprovingReviews: Boolean!
"""