Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
"""
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 SCALAR | OBJECT | FIELD_DEFINITION | ARGUMENT_DEFINITION | INTERFACE | UNION | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
"""
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
"""
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 AcceptTopicSuggestion
"""
input AcceptTopicSuggestionInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The name of the suggested topic.
"""
name: String!
"""
The Node ID of the repository.
"""
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
}
"""
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!
}
"""
Location information for an actor
"""
type ActorLocation {
"""
City
"""
city: String
"""
Country name
"""
country: String
"""
Country code
"""
countryCode: String
"""
Region name
"""
region: String
"""
Region or state code
"""
regionCode: String
}
"""
Autogenerated input type of AddAssigneesToAssignable
"""
input AddAssigneesToAssignableInput {
"""
The id of the assignable object to add assignees to.
"""
assignableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Assignable")
"""
The id of users to add as assignees.
"""
assigneeIds: [ID!]! @possibleTypes(concreteTypes: ["User"])
"""
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 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 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")
}
"""
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 AddProjectNextItem
"""
input AddProjectNextItemInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The content id of the item (Issue or PullRequest).
"""
contentId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "ProjectNextItemContent")
"""
The ID of the Project to add the item to.
"""
projectId: ID! @possibleTypes(concreteTypes: ["ProjectNext"])
}
"""
Autogenerated return type of AddProjectNextItem
"""
type AddProjectNextItemPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item added to the project.
"""
projectNextItem: ProjectNextItem
}
"""
Autogenerated input type of AddPullRequestReviewComment
"""
input AddPullRequestReviewCommentInput {
"""
The text of the comment.
"""
body: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The SHA of the commit to comment on.
"""
commitOID: GitObjectID
"""
The comment id to reply to.
"""
inReplyTo: ID @possibleTypes(concreteTypes: ["PullRequestReviewComment"])
"""
The relative path of the file to comment on.
"""
path: String
"""
The line index in the diff to comment on.
"""
position: Int
"""
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"])
}
"""
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.
"""
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. 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
}
"""
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 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"
"TeamDiscussion"
"TeamDiscussionComment"
]
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 reactable subject.
"""
subject: Reactable
}
"""
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 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 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!
"""
Project referenced by event.
"""
project: Project @preview(toggledBy: "starfox-preview")
"""
Project card referenced by this project event.
"""
projectCard: ProjectCard @preview(toggledBy: "starfox-preview")
"""
Column name referenced by this project event.
"""
projectColumnName: String! @preview(toggledBy: "starfox-preview")
}
"""
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 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 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 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 {
"""
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 user or mannequin that was assigned.
"""
assignee: Assignee
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
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 = Bot | Mannequin | Organization | User
"""
An entry in the audit log.
"""
interface AuditEntry {
"""
The action name
"""
action: String!
"""
The user who initiated the action
"""
actor: AuditEntryActor
"""
The IP address of the actor
"""
actorIp: String
"""
A readable representation of the actor's location
"""
actorLocation: ActorLocation
"""
The username of the user who initiated the action
"""
actorLogin: String
"""
The HTTP path for the actor.
"""
actorResourcePath: URI
"""
The HTTP URL for the actor.
"""
actorUrl: URI
"""
The time the action was initiated
"""
createdAt: PreciseDateTime!
"""
The corresponding operation type for the action
"""
operationType: OperationType
"""
The user affected by the action
"""
user: User
"""
For actions involving two users, the actor is the initiator and the user is the affected user.
"""
userLogin: String
"""
The HTTP path for the user.
"""
userResourcePath: URI
"""
The HTTP URL for the user.
"""
userUrl: URI
}
"""
Types that can initiate an audit log event.
"""
union AuditEntryActor = Bot | Organization | User
"""
Ordering options for Audit Log connections.
"""
input AuditLogOrder {
"""
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 {
"""
Order audit log entries by timestamp
"""
CREATED_AT
}
"""
Represents a 'auto_merge_disabled' event on a given pull request.
"""
type AutoMergeDisabledEvent implements Node {
"""
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
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 {
"""
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
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest
}
"""
Represents an auto-merge request for a pull request
"""
type AutoMergeRequest {
"""
The email address of the author of this auto-merge request.
"""
authorEmail: String
"""
The commit message of the auto-merge request.
"""
commitBody: String
"""
The commit title of the auto-merge request.
"""
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.
"""
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 {
"""
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
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest
}
"""
Represents a 'auto_squash_enabled' event on a given pull request.
"""
type AutoSquashEnabledEvent implements Node {
"""
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
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest
}
"""
Represents a 'automatic_base_change_failed' event on a given pull request.
"""
type AutomaticBaseChangeFailedEvent 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!
"""
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 {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
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 {
"""
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
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 {
"""
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!
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest
}
"""
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 GitObject & Node {
"""
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. 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
}
"""
A special type of user which takes actions on behalf of GitHub Apps.
"""
type Bot implements Actor & Node & 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!
}
"""
Types which can be actors for `BranchActorAllowance` objects.
"""
union BranchActorAllowanceActor = Team | User
"""
A branch protection rule.
"""
type BranchProtectionRule implements Node {
"""
Can this branch be deleted.
"""
allowsDeletions: Boolean!
"""
Are force pushes allowed on this branch.
"""
allowsForcePushes: 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!
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
"""
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
"""
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]
"""
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!
"""
Are reviews from code owners required to update matching branches.
"""
requiresCodeOwnerReviews: Boolean!
"""
Are commits required to be signed.
"""
requiresCommitSignatures: Boolean!
"""
Are conversations required to be resolved before merging.
"""
requiresConversationResolution: Boolean!
"""
Are merge commits prohibited from being pushed to this branch.
"""
requiresLinearHistory: 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
}
"""
A team or user who has the ability to bypass a force push requirement on a protected branch.
"""
type BypassForcePushAllowance implements Node {
"""
The actor that can dismiss.
"""
actor: BranchActorAllowanceActor
"""
Identifies the branch protection rule associated with the allowed user or team.
"""
branchProtectionRule: BranchProtectionRule
id: ID!
}
"""
The connection type for BypassForcePushAllowance.
"""
type BypassForcePushAllowanceConnection {
"""
A list of edges.
"""
edges: [BypassForcePushAllowanceEdge]
"""
A list of nodes.
"""
nodes: [BypassForcePushAllowance]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type BypassForcePushAllowanceEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: BypassForcePushAllowance
}
"""
A team or user who has the ability to bypass a pull request requirement on a protected branch.
"""
type BypassPullRequestAllowance implements Node {
"""
The actor that can dismiss.
"""
actor: BranchActorAllowanceActor
"""
Identifies the branch protection rule associated with the allowed user or team.
"""
branchProtectionRule: BranchProtectionRule
id: ID!
}
"""
The connection type for BypassPullRequestAllowance.
"""
type BypassPullRequestAllowanceConnection {
"""
A list of edges.
"""
edges: [BypassPullRequestAllowanceEdge]
"""
A list of nodes.
"""
nodes: [BypassPullRequestAllowance]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type BypassPullRequestAllowanceEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: BypassPullRequestAllowance
}
"""
The Common Vulnerability Scoring System
"""
type CVSS {
"""
The CVSS score associated with this advisory
"""
score: Float!
"""
The CVSS vector string associated with this advisory
"""
vectorString: String
}
"""
A common weakness enumeration
"""
type CWE implements Node {
"""
The id of the CWE
"""
cweId: String!
"""
A detailed description of this CWE
"""
description: String!
id: ID!
"""
The name of this CWE
"""
name: String!
}
"""
The connection type for CWE.
"""
type CWEConnection {
"""
A list of edges.
"""
edges: [CWEEdge]
"""
A list of nodes.
"""
nodes: [CWE]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CWEEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CWE
}
"""
Autogenerated input type of CancelEnterpriseAdminInvitation
"""
input CancelEnterpriseAdminInvitationInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the pending enterprise administrator invitation.
"""
invitationId: ID! @possibleTypes(concreteTypes: ["EnterpriseAdministratorInvitation"])
}
"""
Autogenerated return type of CancelEnterpriseAdminInvitation
"""
type CancelEnterpriseAdminInvitationPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The invitation that was canceled.
"""
invitation: EnterpriseAdministratorInvitation
"""
A message confirming the result of canceling an administrator invitation.
"""
message: String
}
"""
Autogenerated input type of CancelSponsorship
"""
input CancelSponsorshipInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the user or organization who is acting as the sponsor, paying for
the sponsorship. Required if sponsorLogin is not given.
"""
sponsorId: ID @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "Sponsor")
"""
The username of the user or organization who is acting as the sponsor, paying
for the sponsorship. Required if sponsorId is not given.
"""
sponsorLogin: String
"""
The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.
"""
sponsorableId: ID @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "Sponsorable")
"""
The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.
"""
sponsorableLogin: String
}
"""
Autogenerated return type of CancelSponsorship
"""
type CancelSponsorshipPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The tier that was being used at the time of cancellation.
"""
sponsorsTier: SponsorsTier
}
"""
Autogenerated input type of ChangeUserStatus
"""
input ChangeUserStatusInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., :grinning:.
"""
emoji: String
"""
If set, the user status will not be shown after this date.
"""
expiresAt: DateTime
"""
Whether this status should indicate you are not fully available on GitHub, e.g., you are away.
"""
limitedAvailability: Boolean = false
"""
A short description of your current status.
"""
message: String
"""
The ID of the organization whose members will be allowed to see the status. If
omitted, the status will be publicly visible.
"""
organizationId: ID @possibleTypes(concreteTypes: ["Organization"])
}
"""
Autogenerated return type of ChangeUserStatus
"""
type ChangeUserStatusPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Your updated status.
"""
status: UserStatus
}
"""
A single check annotation.
"""
type CheckAnnotation {
"""
The annotation's severity level.
"""
annotationLevel: CheckAnnotationLevel
"""
The path to the file that this annotation was made on.
"""
blobUrl: URI!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The position of this annotation.
"""
location: CheckAnnotationSpan!
"""
The annotation's message.
"""
message: String!
"""
The path that this annotation was made on.
"""
path: String!
"""
Additional information about the annotation.
"""
rawDetails: String
"""
The annotation's title
"""
title: String
}
"""
The connection type for CheckAnnotation.
"""
type CheckAnnotationConnection {
"""
A list of edges.
"""
edges: [CheckAnnotationEdge]
"""
A list of nodes.
"""
nodes: [CheckAnnotation]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
Information from a check run analysis to specific lines of code.
"""
input CheckAnnotationData {
"""
Represents an annotation's information level
"""
annotationLevel: CheckAnnotationLevel!
"""
The location of the annotation
"""
location: CheckAnnotationRange!
"""
A short description of the feedback for these lines of code.
"""
message: String!
"""
The path of the file to add an annotation to.
"""
path: String!
"""
Details about this annotation.
"""
rawDetails: String
"""
The title that represents the annotation.
"""
title: String
}
"""
An edge in a connection.
"""
type CheckAnnotationEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CheckAnnotation
}
"""
Represents an annotation's information level.
"""
enum CheckAnnotationLevel {
"""
An annotation indicating an inescapable error.
"""
FAILURE
"""
An annotation indicating some information.
"""
NOTICE
"""
An annotation indicating an ignorable error.
"""
WARNING
}
"""
A character position in a check annotation.
"""
type CheckAnnotationPosition {
"""
Column number (1 indexed).
"""
column: Int
"""
Line number (1 indexed).
"""
line: Int!
}
"""
Information from a check run analysis to specific lines of code.
"""
input CheckAnnotationRange {
"""
The ending column of the range.
"""
endColumn: Int
"""
The ending line of the range.
"""
endLine: Int!
"""
The starting column of the range.
"""
startColumn: Int
"""
The starting line of the range.
"""
startLine: Int!
}
"""
An inclusive pair of positions for a check annotation.
"""
type CheckAnnotationSpan {
"""
End position (inclusive).
"""
end: CheckAnnotationPosition!
"""
Start position (inclusive).
"""
start: CheckAnnotationPosition!
}
"""
The possible states for a check suite or run conclusion.
"""
enum CheckConclusionState {
"""
The check suite or run requires action.
"""
ACTION_REQUIRED
"""
The check suite or run has been cancelled.
"""
CANCELLED
"""
The check suite or run has failed.
"""
FAILURE
"""
The check suite or run was neutral.
"""
NEUTRAL
"""
The check suite or run was skipped.
"""
SKIPPED
"""
The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.
"""
STALE
"""
The check suite or run has failed at startup.
"""
STARTUP_FAILURE
"""
The check suite or run has succeeded.
"""
SUCCESS
"""
The check suite or run has timed out.
"""
TIMED_OUT
}
"""
A check run.
"""
type CheckRun implements Node & RequirableByPullRequest & UniformResourceLocatable {
"""
The check run's annotations
"""
annotations(
"""
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
): CheckAnnotationConnection
"""
The check suite that this run is a part of.
"""
checkSuite: CheckSuite!
"""
Identifies the date and time when the check run was completed.
"""
completedAt: DateTime
"""
The conclusion of the check run.
"""
conclusion: CheckConclusionState
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The corresponding deployment for this job, if any
"""
deployment: Deployment
"""
The URL from which to find full details of the check run on the integrator's site.
"""
detailsUrl: URI
"""
A reference for the check run on the integrator's system.
"""
externalId: String
id: ID!
"""
Whether this is required to pass before merging for a specific pull request.
"""
isRequired(
"""
The id of the pull request this is required for
"""
pullRequestId: ID
"""
The number of the pull request this is required for
"""
pullRequestNumber: Int
): Boolean!
"""
The name of the check for this check run.
"""
name: String!
"""
Information about a pending deployment, if any, in this check run
"""
pendingDeploymentRequest: DeploymentRequest
"""
The permalink to the check run summary.
"""
permalink: URI!
"""
The repository associated with this check run.
"""
repository: Repository!
"""
The HTTP path for this check run.
"""
resourcePath: URI!
"""
Identifies the date and time when the check run was started.
"""
startedAt: DateTime
"""
The current status of the check run.
"""
status: CheckStatusState!
"""
The check run's steps
"""
steps(
"""
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
"""
Step number
"""
number: Int
): CheckStepConnection
"""
A string representing the check run's summary
"""
summary: String
"""
A string representing the check run's text
"""
text: String
"""
A string representing the check run
"""
title: String
"""
The HTTP URL for this check run.
"""
url: URI!
}
"""
Possible further actions the integrator can perform.
"""
input CheckRunAction {
"""
A short explanation of what this action would do.
"""
description: String!
"""
A reference for the action on the integrator's system.
"""
identifier: String!
"""
The text to be displayed on a button in the web UI.
"""
label: String!
}
"""
The connection type for CheckRun.
"""
type CheckRunConnection {
"""
A list of edges.
"""
edges: [CheckRunEdge]
"""
A list of nodes.
"""
nodes: [CheckRun]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CheckRunEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CheckRun
}
"""
The filters that are available when fetching check runs.
"""
input CheckRunFilter {
"""
Filters the check runs created by this application ID.
"""
appId: Int
"""
Filters the check runs by this name.
"""
checkName: String
"""
Filters the check runs by this type.
"""
checkType: CheckRunType
"""
Filters the check runs by this status.
"""
status: CheckStatusState
}
"""
Descriptive details about the check run.
"""
input CheckRunOutput {
"""
The annotations that are made as part of the check run.
"""
annotations: [CheckAnnotationData!]
"""
Images attached to the check run output displayed in the GitHub pull request UI.
"""
images: [CheckRunOutputImage!]
"""
The summary of the check run (supports Commonmark).
"""
summary: String!
"""
The details of the check run (supports Commonmark).
"""
text: String
"""
A title to provide for this check run.
"""
title: String!
}
"""
Images attached to the check run output displayed in the GitHub pull request UI.
"""