Skip to content

Instantly share code, notes, and snippets.

@johngrib

johngrib/schema.docs.graphql

Last active January 30, 2022 12:34
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save johngrib/32436503ccb7c95f0c13a1174d6db2f2 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save johngrib/32436503ccb7c95f0c13a1174d6db2f2 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
schema.docs.graphql
"""
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.
"""
input CheckRunOutputImage {
"""
The alternative text for the image.
"""
alt: String!
"""
A short image description.
"""
caption: String
"""
The full URL of the image.
"""
imageUrl: URI!
}
"""
The possible types of check runs.
"""
enum CheckRunType {
"""
Every check run available.
"""
ALL
"""
The latest check run.
"""
LATEST
}
"""
The possible states for a check suite or run status.
"""
enum CheckStatusState {
"""
The check suite or run has been completed.
"""
COMPLETED
"""
The check suite or run is in progress.
"""
IN_PROGRESS
"""
The check suite or run is in pending state.
"""
PENDING
"""
The check suite or run has been queued.
"""
QUEUED
"""
The check suite or run has been requested.
"""
REQUESTED
"""
The check suite or run is in waiting state.
"""
WAITING
}
"""
A single check step.
"""
type CheckStep {
"""
Identifies the date and time when the check step was completed.
"""
completedAt: DateTime
"""
The conclusion of the check step.
"""
conclusion: CheckConclusionState
"""
A reference for the check step on the integrator's system.
"""
externalId: String
"""
The step's name.
"""
name: String!
"""
The index of the step in the list of steps of the parent check run.
"""
number: Int!
"""
Number of seconds to completion.
"""
secondsToCompletion: Int
"""
Identifies the date and time when the check step was started.
"""
startedAt: DateTime
"""
The current status of the check step.
"""
status: CheckStatusState!
}
"""
The connection type for CheckStep.
"""
type CheckStepConnection {
"""
A list of edges.
"""
edges: [CheckStepEdge]
"""
A list of nodes.
"""
nodes: [CheckStep]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CheckStepEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CheckStep
}
"""
A check suite.
"""
type CheckSuite implements Node {
"""
The GitHub App which created this check suite.
"""
app: App
"""
The name of the branch for this check suite.
"""
branch: Ref
"""
The check runs associated with a check suite.
"""
checkRuns(
"""
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
"""
Filters the check runs by this type.
"""
filterBy: CheckRunFilter
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): CheckRunConnection
"""
The commit for this check suite
"""
commit: Commit!
"""
The conclusion of this check suite.
"""
conclusion: CheckConclusionState
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The user who triggered the check suite.
"""
creator: User
"""
Identifies the primary key from the database.
"""
databaseId: Int
id: ID!
"""
A list of open pull requests matching the check suite.
"""
matchingPullRequests(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
The base ref name to filter the pull requests by.
"""
baseRefName: 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
"""
The head ref name to filter the pull requests by.
"""
headRefName: String
"""
A list of label names to filter the pull requests by.
"""
labels: [String!]
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for pull requests returned from the connection.
"""
orderBy: IssueOrder
"""
A list of states to filter the pull requests by.
"""
states: [PullRequestState!]
): PullRequestConnection
"""
The push that triggered this check suite.
"""
push: Push
"""
The repository associated with this check suite.
"""
repository: Repository!
"""
The HTTP path for this check suite
"""
resourcePath: URI!
"""
The status of this check suite.
"""
status: CheckStatusState!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The HTTP URL for this check suite
"""
url: URI!
"""
The workflow run associated with this check suite.
"""
workflowRun: WorkflowRun
}
"""
The auto-trigger preferences that are available for check suites.
"""
input CheckSuiteAutoTriggerPreference {
"""
The node ID of the application that owns the check suite.
"""
appId: ID!
"""
Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository.
"""
setting: Boolean!
}
"""
The connection type for CheckSuite.
"""
type CheckSuiteConnection {
"""
A list of edges.
"""
edges: [CheckSuiteEdge]
"""
A list of nodes.
"""
nodes: [CheckSuite]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CheckSuiteEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CheckSuite
}
"""
The filters that are available when fetching check suites.
"""
input CheckSuiteFilter {
"""
Filters the check suites created by this application ID.
"""
appId: Int
"""
Filters the check suites by this name.
"""
checkName: String
}
"""
Autogenerated input type of ClearLabelsFromLabelable
"""
input ClearLabelsFromLabelableInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the labelable object to clear the labels from.
"""
labelableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Labelable")
}
"""
Autogenerated return type of ClearLabelsFromLabelable
"""
type ClearLabelsFromLabelablePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item that was unlabeled.
"""
labelable: Labelable
}
"""
Autogenerated input type of CloneProject
"""
input CloneProjectInput {
"""
The description of the project.
"""
body: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Whether or not to clone the source project's workflows.
"""
includeWorkflows: Boolean!
"""
The name of the project.
"""
name: String!
"""
The visibility of the project, defaults to false (private).
"""
public: Boolean
"""
The source project to clone.
"""
sourceId: ID! @possibleTypes(concreteTypes: ["Project"])
"""
The owner ID to create the project under.
"""
targetOwnerId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository", "User"], abstractType: "ProjectOwner")
}
"""
Autogenerated return type of CloneProject
"""
type CloneProjectPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the JobStatus for populating cloned fields.
"""
jobStatusId: String
"""
The new cloned project.
"""
project: Project
}
"""
Autogenerated input type of CloneTemplateRepository
"""
input CloneTemplateRepositoryInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A short description of the new repository.
"""
description: String
"""
Whether to copy all branches from the template to the new repository. Defaults
to copying only the default branch of the template.
"""
includeAllBranches: Boolean = false
"""
The name of the new repository.
"""
name: String!
"""
The ID of the owner for the new repository.
"""
ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "RepositoryOwner")
"""
The Node ID of the template repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
"""
Indicates the repository's visibility level.
"""
visibility: RepositoryVisibility!
}
"""
Autogenerated return type of CloneTemplateRepository
"""
type CloneTemplateRepositoryPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new repository.
"""
repository: Repository
}
"""
An object that can be closed
"""
interface Closable {
"""
`true` if the object is closed (definition of closed may depend on type)
"""
closed: Boolean!
"""
Identifies the date and time when the object was closed.
"""
closedAt: DateTime
}
"""
Autogenerated input type of CloseIssue
"""
input CloseIssueInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
ID of the issue to be closed.
"""
issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
}
"""
Autogenerated return type of CloseIssue
"""
type CloseIssuePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The issue that was closed.
"""
issue: Issue
}
"""
Autogenerated input type of ClosePullRequest
"""
input ClosePullRequestInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
ID of the pull request to be closed.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
Autogenerated return type of ClosePullRequest
"""
type ClosePullRequestPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The pull request that was closed.
"""
pullRequest: PullRequest
}
"""
Represents a 'closed' event on any `Closable`.
"""
type ClosedEvent implements Node & UniformResourceLocatable {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Object that was closed.
"""
closable: Closable!
"""
Object which triggered the creation of this event.
"""
closer: Closer
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
The HTTP path for this closed event.
"""
resourcePath: URI!
"""
The HTTP URL for this closed event.
"""
url: URI!
}
"""
The object which triggered a `ClosedEvent`.
"""
union Closer = Commit | PullRequest
"""
The Code of Conduct for a repository
"""
type CodeOfConduct implements Node {
"""
The body of the Code of Conduct
"""
body: String
id: ID!
"""
The key for the Code of Conduct
"""
key: String!
"""
The formal name of the Code of Conduct
"""
name: String!
"""
The HTTP path for this Code of Conduct
"""
resourcePath: URI
"""
The HTTP URL for this Code of Conduct
"""
url: URI
}
"""
Collaborators affiliation level with a subject.
"""
enum CollaboratorAffiliation {
"""
All collaborators the authenticated user can see.
"""
ALL
"""
All collaborators with permissions to an organization-owned subject, regardless of organization membership status.
"""
DIRECT
"""
All outside collaborators of an organization-owned subject.
"""
OUTSIDE
}
"""
Represents a comment.
"""
interface Comment {
"""
The actor who authored the comment.
"""
author: Actor
"""
Author's association with the subject of the comment.
"""
authorAssociation: CommentAuthorAssociation!
"""
The body as Markdown.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The body rendered to text.
"""
bodyText: String!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
The actor who edited the comment.
"""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
A list of edits to this content.
"""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserContentEditConnection
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
}
"""
A comment author association with repository.
"""
enum CommentAuthorAssociation {
"""
Author has been invited to collaborate on the repository.
"""
COLLABORATOR
"""
Author has previously committed to the repository.
"""
CONTRIBUTOR
"""
Author has not previously committed to GitHub.
"""
FIRST_TIMER
"""
Author has not previously committed to the repository.
"""
FIRST_TIME_CONTRIBUTOR
"""
Author is a placeholder for an unclaimed user.
"""
MANNEQUIN
"""
Author is a member of the organization that owns the repository.
"""
MEMBER
"""
Author has no association with the repository.
"""
NONE
"""
Author is the owner of the repository.
"""
OWNER
}
"""
The possible errors that will prevent a user from updating a comment.
"""
enum CommentCannotUpdateReason {
"""
Unable to create comment because repository is archived.
"""
ARCHIVED
"""
You cannot update this comment
"""
DENIED
"""
You must be the author or have write access to this repository to update this comment.
"""
INSUFFICIENT_ACCESS
"""
Unable to create comment because issue is locked.
"""
LOCKED
"""
You must be logged in to update this comment.
"""
LOGIN_REQUIRED
"""
Repository is under maintenance.
"""
MAINTENANCE
"""
At least one email address must be verified to update this comment.
"""
VERIFIED_EMAIL_REQUIRED
}
"""
Represents a 'comment_deleted' event on a given issue or pull request.
"""
type CommentDeletedEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The user who authored the deleted comment.
"""
deletedCommentAuthor: Actor
id: ID!
}
"""
Represents a Git commit.
"""
type Commit implements GitObject & Node & Subscribable & UniformResourceLocatable {
"""
An abbreviated version of the Git object ID
"""
abbreviatedOid: String!
"""
The number of additions in this commit.
"""
additions: Int!
"""
The merged Pull Request that introduced the commit to the repository. If the
commit is not present in the default branch, additionally returns open Pull
Requests associated with the commit
"""
associatedPullRequests(
"""
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 pull requests.
"""
orderBy: PullRequestOrder = {field: CREATED_AT, direction: ASC}
): PullRequestConnection
"""
Authorship details of the commit.
"""
author: GitActor
"""
Check if the committer and the author match.
"""
authoredByCommitter: Boolean!
"""
The datetime when this commit was authored.
"""
authoredDate: DateTime!
"""
The list of authors for this commit based on the git author and the Co-authored-by
message trailer. The git author will always be first.
"""
authors(
"""
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
): GitActorConnection!
"""
Fetches `git blame` information.
"""
blame(
"""
The file whose Git blame information you want.
"""
path: String!
): Blame!
"""
The number of changed files in this commit.
"""
changedFiles: Int!
"""
The check suites associated with a commit.
"""
checkSuites(
"""
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
"""
Filters the check suites by this type.
"""
filterBy: CheckSuiteFilter
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): CheckSuiteConnection
"""
Comments made on the commit.
"""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): CommitCommentConnection!
"""
The HTTP path for this Git object
"""
commitResourcePath: URI!
"""
The HTTP URL for this Git object
"""
commitUrl: URI!
"""
The datetime when this commit was committed.
"""
committedDate: DateTime!
"""
Check if committed via GitHub web UI.
"""
committedViaWeb: Boolean!
"""
Committer details of the commit.
"""
committer: GitActor
"""
The number of deletions in this commit.
"""
deletions: Int!
"""
The deployments associated with a commit.
"""
deployments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Environments to list deployments for
"""
environments: [String!]
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for deployments returned from the connection.
"""
orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC}
): DeploymentConnection
"""
The tree entry representing the file located at the given path.
"""
file(
"""
The path for the file
"""
path: String!
): TreeEntry
"""
The linear commit history starting from (and including) this commit, in the same order as `git log`.
"""
history(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
If non-null, filters history to only show commits with matching authorship.
"""
author: CommitAuthor
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
If non-null, filters history to only show commits touching files under this path.
"""
path: String
"""
Allows specifying a beginning time or date for fetching commits.
"""
since: GitTimestamp
"""
Allows specifying an ending time or date for fetching commits.
"""
until: GitTimestamp
): CommitHistoryConnection!
id: ID!
"""
The Git commit message
"""
message: String!
"""
The Git commit message body
"""
messageBody: String!
"""
The commit message body rendered to HTML.
"""
messageBodyHTML: HTML!
"""
The Git commit message headline
"""
messageHeadline: String!
"""
The commit message headline rendered to HTML.
"""
messageHeadlineHTML: HTML!
"""
The Git object ID
"""
oid: GitObjectID!
"""
The organization this commit was made on behalf of.
"""
onBehalfOf: Organization
"""
The parents of a commit.
"""
parents(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): CommitConnection!
"""
The datetime when this commit was pushed.
"""
pushedDate: DateTime
"""
The Repository this commit belongs to
"""
repository: Repository!
"""
The HTTP path for this commit
"""
resourcePath: URI!
"""
Commit signing information, if present.
"""
signature: GitSignature
"""
Status information for this commit
"""
status: Status
"""
Check and Status rollup information for this commit.
"""
statusCheckRollup: StatusCheckRollup
"""
Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.
"""
submodules(
"""
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
): SubmoduleConnection!
"""
Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
"""
tarballUrl: URI!
"""
Commit's root Tree
"""
tree: Tree!
"""
The HTTP path for the tree of this commit
"""
treeResourcePath: URI!
"""
The HTTP URL for the tree of this commit
"""
treeUrl: URI!
"""
The HTTP URL for this commit
"""
url: URI!
"""
Check if the viewer is able to change their subscription status for the repository.
"""
viewerCanSubscribe: Boolean!
"""
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
viewerSubscription: SubscriptionState
"""
Returns a URL to download a zipball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
"""
zipballUrl: URI!
}
"""
Specifies an author for filtering Git commits.
"""
input CommitAuthor {
"""
Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.
"""
emails: [String!]
"""
ID of a User to filter by. If non-null, only commits authored by this user
will be returned. This field takes precedence over emails.
"""
id: ID
}
"""
Represents a comment on a given Commit.
"""
type CommitComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
"""
The actor who authored the comment.
"""
author: Actor
"""
Author's association with the subject of the comment.
"""
authorAssociation: CommentAuthorAssociation!
"""
Identifies the comment body.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The body rendered to text.
"""
bodyText: String!
"""
Identifies the commit associated with the comment, if the commit exists.
"""
commit: Commit
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The actor who edited the comment.
"""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
Returns whether or not a comment has been minimized.
"""
isMinimized: Boolean!
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
Returns why the comment was minimized.
"""
minimizedReason: String
"""
Identifies the file path associated with the comment.
"""
path: String
"""
Identifies the line position associated with the comment.
"""
position: Int
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
A list of reactions grouped by content left on the subject.
"""
reactionGroups: [ReactionGroup!]
"""
A list of Reactions left on the Issue.
"""
reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Allows filtering Reactions by emoji.
"""
content: ReactionContent
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Allows specifying the order in which reactions are returned.
"""
orderBy: ReactionOrder
): ReactionConnection!
"""
The repository associated with this node.
"""
repository: Repository!
"""
The HTTP path permalink for this commit comment.
"""
resourcePath: URI!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The HTTP URL permalink for this commit comment.
"""
url: URI!
"""
A list of edits to this content.
"""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserContentEditConnection
"""
Check if the current viewer can delete this object.
"""
viewerCanDelete: Boolean!
"""
Check if the current viewer can minimize this object.
"""
viewerCanMinimize: Boolean!
"""
Can user react to this subject
"""
viewerCanReact: Boolean!
"""
Check if the current viewer can update this object.
"""
viewerCanUpdate: Boolean!
"""
Reasons why the current viewer can not update this comment.
"""
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
}
"""
The connection type for CommitComment.
"""
type CommitCommentConnection {
"""
A list of edges.
"""
edges: [CommitCommentEdge]
"""
A list of nodes.
"""
nodes: [CommitComment]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CommitCommentEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CommitComment
}
"""
A thread of comments on a commit.
"""
type CommitCommentThread implements Node & RepositoryNode {
"""
The comments that exist in this thread.
"""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): CommitCommentConnection!
"""
The commit the comments were made on.
"""
commit: Commit
id: ID!
"""
The file the comments were made on.
"""
path: String
"""
The position in the diff for the commit that the comment was made on.
"""
position: Int
"""
The repository associated with this node.
"""
repository: Repository!
}
"""
The connection type for Commit.
"""
type CommitConnection {
"""
A list of edges.
"""
edges: [CommitEdge]
"""
A list of nodes.
"""
nodes: [Commit]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
Ordering options for commit contribution connections.
"""
input CommitContributionOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field by which to order commit contributions.
"""
field: CommitContributionOrderField!
}
"""
Properties by which commit contribution connections can be ordered.
"""
enum CommitContributionOrderField {
"""
Order commit contributions by how many commits they represent.
"""
COMMIT_COUNT
"""
Order commit contributions by when they were made.
"""
OCCURRED_AT
}
"""
This aggregates commits made by a user within one repository.
"""
type CommitContributionsByRepository {
"""
The commit contributions, each representing a day.
"""
contributions(
"""
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 commit contributions returned from the connection.
"""
orderBy: CommitContributionOrder = {field: OCCURRED_AT, direction: DESC}
): CreatedCommitContributionConnection!
"""
The repository in which the commits were made.
"""
repository: Repository!
"""
The HTTP path for the user's commits to the repository in this time range.
"""
resourcePath: URI!
"""
The HTTP URL for the user's commits to the repository in this time range.
"""
url: URI!
}
"""
An edge in a connection.
"""
type CommitEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Commit
}
"""
The connection type for Commit.
"""
type CommitHistoryConnection {
"""
A list of edges.
"""
edges: [CommitEdge]
"""
A list of nodes.
"""
nodes: [Commit]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
A message to include with a new commit
"""
input CommitMessage {
"""
The body of the message.
"""
body: String
"""
The headline of the message.
"""
headline: String!
}
"""
A git ref for a commit to be appended to.
The ref must be a branch, i.e. its fully qualified name must start
with `refs/heads/` (although the input is not required to be fully
qualified).
The Ref may be specified by its global node ID or by the
repository nameWithOwner and branch name.
### Examples
Specify a branch using a global node ID:
{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }
Specify a branch using nameWithOwner and branch name:
{
"nameWithOwner": "github/graphql-client",
"branchName": "main"
}
"""
input CommittableBranch {
"""
The unqualified name of the branch to append the commit to.
"""
branchName: String
"""
The Node ID of the Ref to be updated.
"""
id: ID
"""
The nameWithOwner of the repository to commit to.
"""
repositoryNameWithOwner: String
}
"""
Represents a 'connected' event on a given issue or pull request.
"""
type ConnectedEvent 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!
"""
Reference originated in a different repository.
"""
isCrossRepository: Boolean!
"""
Issue or pull request that made the reference.
"""
source: ReferencedSubject!
"""
Issue or pull request which was connected.
"""
subject: ReferencedSubject!
}
"""
Represents a contribution a user made on GitHub, such as opening an issue.
"""
interface Contribution {
"""
Whether this contribution is associated with a record you do not have access to. For
example, your own 'first issue' contribution may have been made on a repository you can no
longer access.
"""
isRestricted: Boolean!
"""
When this contribution was made.
"""
occurredAt: DateTime!
"""
The HTTP path for this contribution.
"""
resourcePath: URI!
"""
The HTTP URL for this contribution.
"""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""
A calendar of contributions made on GitHub by a user.
"""
type ContributionCalendar {
"""
A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.
"""
colors: [String!]!
"""
Determine if the color set was chosen because it's currently Halloween.
"""
isHalloween: Boolean!
"""
A list of the months of contributions in this calendar.
"""
months: [ContributionCalendarMonth!]!
"""
The count of total contributions in the calendar.
"""
totalContributions: Int!
"""
A list of the weeks of contributions in this calendar.
"""
weeks: [ContributionCalendarWeek!]!
}
"""
Represents a single day of contributions on GitHub by a user.
"""
type ContributionCalendarDay {
"""
The hex color code that represents how many contributions were made on this day compared to others in the calendar.
"""
color: String!
"""
How many contributions were made by the user on this day.
"""
contributionCount: Int!
"""
Indication of contributions, relative to other days. Can be used to indicate
which color to represent this day on a calendar.
"""
contributionLevel: ContributionLevel!
"""
The day this square represents.
"""
date: Date!
"""
A number representing which day of the week this square represents, e.g., 1 is Monday.
"""
weekday: Int!
}
"""
A month of contributions in a user's contribution graph.
"""
type ContributionCalendarMonth {
"""
The date of the first day of this month.
"""
firstDay: Date!
"""
The name of the month.
"""
name: String!
"""
How many weeks started in this month.
"""
totalWeeks: Int!
"""
The year the month occurred in.
"""
year: Int!
}
"""
A week of contributions in a user's contribution graph.
"""
type ContributionCalendarWeek {
"""
The days of contributions in this week.
"""
contributionDays: [ContributionCalendarDay!]!
"""
The date of the earliest square in this week.
"""
firstDay: Date!
}
"""
Varying levels of contributions from none to many.
"""
enum ContributionLevel {
"""
Lowest 25% of days of contributions.
"""
FIRST_QUARTILE
"""
Highest 25% of days of contributions. More contributions than the third quartile.
"""
FOURTH_QUARTILE
"""
No contributions occurred.
"""
NONE
"""
Second lowest 25% of days of contributions. More contributions than the first quartile.
"""
SECOND_QUARTILE
"""
Second highest 25% of days of contributions. More contributions than second quartile, less than the fourth quartile.
"""
THIRD_QUARTILE
}
"""
Ordering options for contribution connections.
"""
input ContributionOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
}
"""
A contributions collection aggregates contributions such as opened issues and commits created by a user.
"""
type ContributionsCollection {
"""
Commit contributions made by the user, grouped by repository.
"""
commitContributionsByRepository(
"""
How many repositories should be included.
"""
maxRepositories: Int = 25
): [CommitContributionsByRepository!]!
"""
A calendar of this user's contributions on GitHub.
"""
contributionCalendar: ContributionCalendar!
"""
The years the user has been making contributions with the most recent year first.
"""
contributionYears: [Int!]!
"""
Determine if this collection's time span ends in the current month.
"""
doesEndInCurrentMonth: Boolean!
"""
The date of the first restricted contribution the user made in this time
period. Can only be non-null when the user has enabled private contribution counts.
"""
earliestRestrictedContributionDate: Date
"""
The ending date and time of this collection.
"""
endedAt: DateTime!
"""
The first issue the user opened on GitHub. This will be null if that issue was
opened outside the collection's time range and ignoreTimeRange is false. If
the issue is not visible but the user has opted to show private contributions,
a RestrictedContribution will be returned.
"""
firstIssueContribution: CreatedIssueOrRestrictedContribution
"""
The first pull request the user opened on GitHub. This will be null if that
pull request was opened outside the collection's time range and
ignoreTimeRange is not true. If the pull request is not visible but the user
has opted to show private contributions, a RestrictedContribution will be returned.
"""
firstPullRequestContribution: CreatedPullRequestOrRestrictedContribution
"""
The first repository the user created on GitHub. This will be null if that
first repository was created outside the collection's time range and
ignoreTimeRange is false. If the repository is not visible, then a
RestrictedContribution is returned.
"""
firstRepositoryContribution: CreatedRepositoryOrRestrictedContribution
"""
Does the user have any more activity in the timeline that occurred prior to the collection's time range?
"""
hasActivityInThePast: Boolean!
"""
Determine if there are any contributions in this collection.
"""
hasAnyContributions: Boolean!
"""
Determine if the user made any contributions in this time frame whose details
are not visible because they were made in a private repository. Can only be
true if the user enabled private contribution counts.
"""
hasAnyRestrictedContributions: Boolean!
"""
Whether or not the collector's time span is all within the same day.
"""
isSingleDay: Boolean!
"""
A list of issues the user opened.
"""
issueContributions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Should the user's first issue ever be excluded from the result.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented issue be excluded from the result.
"""
excludePopular: Boolean = false
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for contributions returned from the connection.
"""
orderBy: ContributionOrder = {direction: DESC}
): CreatedIssueContributionConnection!
"""
Issue contributions made by the user, grouped by repository.
"""
issueContributionsByRepository(
"""
Should the user's first issue ever be excluded from the result.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented issue be excluded from the result.
"""
excludePopular: Boolean = false
"""
How many repositories should be included.
"""
maxRepositories: Int = 25
): [IssueContributionsByRepository!]!
"""
When the user signed up for GitHub. This will be null if that sign up date
falls outside the collection's time range and ignoreTimeRange is false.
"""
joinedGitHubContribution: JoinedGitHubContribution
"""
The date of the most recent restricted contribution the user made in this time
period. Can only be non-null when the user has enabled private contribution counts.
"""
latestRestrictedContributionDate: Date
"""
When this collection's time range does not include any activity from the user, use this
to get a different collection from an earlier time range that does have activity.
"""
mostRecentCollectionWithActivity: ContributionsCollection
"""
Returns a different contributions collection from an earlier time range than this one
that does not have any contributions.
"""
mostRecentCollectionWithoutActivity: ContributionsCollection
"""
The issue the user opened on GitHub that received the most comments in the specified
time frame.
"""
popularIssueContribution: CreatedIssueContribution
"""
The pull request the user opened on GitHub that received the most comments in the
specified time frame.
"""
popularPullRequestContribution: CreatedPullRequestContribution
"""
Pull request contributions made by the user.
"""
pullRequestContributions(
"""
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
"""
Should the user's first pull request ever be excluded from the result.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented pull request be excluded from the result.
"""
excludePopular: Boolean = false
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for contributions returned from the connection.
"""
orderBy: ContributionOrder = {direction: DESC}
): CreatedPullRequestContributionConnection!
"""
Pull request contributions made by the user, grouped by repository.
"""
pullRequestContributionsByRepository(
"""
Should the user's first pull request ever be excluded from the result.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented pull request be excluded from the result.
"""
excludePopular: Boolean = false
"""
How many repositories should be included.
"""
maxRepositories: Int = 25
): [PullRequestContributionsByRepository!]!
"""
Pull request review contributions made by the user.
"""
pullRequestReviewContributions(
"""
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 contributions returned from the connection.
"""
orderBy: ContributionOrder = {direction: DESC}
): CreatedPullRequestReviewContributionConnection!
"""
Pull request review contributions made by the user, grouped by repository.
"""
pullRequestReviewContributionsByRepository(
"""
How many repositories should be included.
"""
maxRepositories: Int = 25
): [PullRequestReviewContributionsByRepository!]!
"""
A list of repositories owned by the user that the user created in this time range.
"""
repositoryContributions(
"""
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
"""
Should the user's first repository ever be excluded from the result.
"""
excludeFirst: Boolean = false
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for contributions returned from the connection.
"""
orderBy: ContributionOrder = {direction: DESC}
): CreatedRepositoryContributionConnection!
"""
A count of contributions made by the user that the viewer cannot access. Only
non-zero when the user has chosen to share their private contribution counts.
"""
restrictedContributionsCount: Int!
"""
The beginning date and time of this collection.
"""
startedAt: DateTime!
"""
How many commits were made by the user in this time span.
"""
totalCommitContributions: Int!
"""
How many issues the user opened.
"""
totalIssueContributions(
"""
Should the user's first issue ever be excluded from this count.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented issue be excluded from this count.
"""
excludePopular: Boolean = false
): Int!
"""
How many pull requests the user opened.
"""
totalPullRequestContributions(
"""
Should the user's first pull request ever be excluded from this count.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented pull request be excluded from this count.
"""
excludePopular: Boolean = false
): Int!
"""
How many pull request reviews the user left.
"""
totalPullRequestReviewContributions: Int!
"""
How many different repositories the user committed to.
"""
totalRepositoriesWithContributedCommits: Int!
"""
How many different repositories the user opened issues in.
"""
totalRepositoriesWithContributedIssues(
"""
Should the user's first issue ever be excluded from this count.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented issue be excluded from this count.
"""
excludePopular: Boolean = false
): Int!
"""
How many different repositories the user left pull request reviews in.
"""
totalRepositoriesWithContributedPullRequestReviews: Int!
"""
How many different repositories the user opened pull requests in.
"""
totalRepositoriesWithContributedPullRequests(
"""
Should the user's first pull request ever be excluded from this count.
"""
excludeFirst: Boolean = false
"""
Should the user's most commented pull request be excluded from this count.
"""
excludePopular: Boolean = false
): Int!
"""
How many repositories the user created.
"""
totalRepositoryContributions(
"""
Should the user's first repository ever be excluded from this count.
"""
excludeFirst: Boolean = false
): Int!
"""
The user who made the contributions in this collection.
"""
user: User!
}
"""
Autogenerated input type of ConvertProjectCardNoteToIssue
"""
input ConvertProjectCardNoteToIssueInput {
"""
The body of the newly created issue.
"""
body: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ProjectCard ID to convert.
"""
projectCardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
"""
The ID of the repository to create the issue in.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
"""
The title of the newly created issue. Defaults to the card's note text.
"""
title: String
}
"""
Autogenerated return type of ConvertProjectCardNoteToIssue
"""
type ConvertProjectCardNoteToIssuePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The updated ProjectCard.
"""
projectCard: ProjectCard
}
"""
Autogenerated input type of ConvertPullRequestToDraft
"""
input ConvertPullRequestToDraftInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
ID of the pull request to convert to draft
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
Autogenerated return type of ConvertPullRequestToDraft
"""
type ConvertPullRequestToDraftPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The pull request that is now a draft.
"""
pullRequest: PullRequest
}
"""
Represents a 'convert_to_draft' event on a given pull request.
"""
type ConvertToDraftEvent implements Node & UniformResourceLocatable {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
"""
The HTTP path for this convert to draft event.
"""
resourcePath: URI!
"""
The HTTP URL for this convert to draft event.
"""
url: URI!
}
"""
Represents a 'converted_note_to_issue' event on a given issue or pull request.
"""
type ConvertedNoteToIssueEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the primary key from the database.
"""
databaseId: Int
id: ID!
"""
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")
}
"""
Represents a 'converted_to_discussion' event on a given issue.
"""
type ConvertedToDiscussionEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The discussion that the issue was converted into.
"""
discussion: Discussion
id: ID!
}
"""
Autogenerated input type of CreateBranchProtectionRule
"""
input CreateBranchProtectionRuleInput {
"""
Can this branch be deleted.
"""
allowsDeletions: Boolean
"""
Are force pushes allowed on this branch.
"""
allowsForcePushes: Boolean
"""
A list of User or Team IDs allowed to bypass force push targeting matching branches.
"""
bypassForcePushActorIds: [ID!]
"""
A list of User or Team IDs allowed to bypass pull requests targeting matching branches.
"""
bypassPullRequestActorIds: [ID!]
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Will new commits pushed to matching branches dismiss pull request review approvals.
"""
dismissesStaleReviews: Boolean
"""
Can admins overwrite branch protection.
"""
isAdminEnforced: Boolean
"""
The glob-like pattern used to determine matching branches.
"""
pattern: String!
"""
A list of User, Team or App IDs allowed to push to matching branches.
"""
pushActorIds: [ID!]
"""
The global relay id of the repository in which a new branch protection rule should be created in.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["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!]
"""
The list of required status checks
"""
requiredStatusChecks: [RequiredStatusCheckInput!]
"""
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 of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.
"""
reviewDismissalActorIds: [ID!]
}
"""
Autogenerated return type of CreateBranchProtectionRule
"""
type CreateBranchProtectionRulePayload {
"""
The newly created BranchProtectionRule.
"""
branchProtectionRule: BranchProtectionRule
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of CreateCheckRun
"""
input CreateCheckRunInput {
"""
Possible further actions the integrator can perform, which a user may trigger.
"""
actions: [CheckRunAction!]
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The time that the check run finished.
"""
completedAt: DateTime
"""
The final conclusion of the check.
"""
conclusion: CheckConclusionState
"""
The URL of the integrator's site that has the full details of the check.
"""
detailsUrl: URI
"""
A reference for the run on the integrator's system.
"""
externalId: String
"""
The SHA of the head commit.
"""
headSha: GitObjectID!
"""
The name of the check.
"""
name: String!
"""
Descriptive details about the run.
"""
output: CheckRunOutput
"""
The node ID of the repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
"""
The time that the check run began.
"""
startedAt: DateTime
"""
The current status.
"""
status: RequestableCheckStatusState
}
"""
Autogenerated return type of CreateCheckRun
"""
type CreateCheckRunPayload {
"""
The newly created check run.
"""
checkRun: CheckRun
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of CreateCheckSuite
"""
input CreateCheckSuiteInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The SHA of the head commit.
"""
headSha: GitObjectID!
"""
The Node ID of the repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
Autogenerated return type of CreateCheckSuite
"""
type CreateCheckSuitePayload {
"""
The newly created check suite.
"""
checkSuite: CheckSuite
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of CreateCommitOnBranch
"""
input CreateCommitOnBranchInput {
"""
The Ref to be updated. Must be a branch.
"""
branch: CommittableBranch!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The git commit oid expected at the head of the branch prior to the commit
"""
expectedHeadOid: GitObjectID!
"""
A description of changes to files in this commit.
"""
fileChanges: FileChanges
"""
The commit message the be included with the commit.
"""
message: CommitMessage!
}
"""
Autogenerated return type of CreateCommitOnBranch
"""
type CreateCommitOnBranchPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new commit.
"""
commit: Commit
"""
The ref which has been updated to point to the new commit.
"""
ref: Ref
}
"""
Autogenerated input type of CreateDeployment
"""
input CreateDeploymentInput @preview(toggledBy: "flash-preview") {
"""
Attempt to automatically merge the default branch into the requested ref, defaults to true.
"""
autoMerge: Boolean = true
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Short description of the deployment.
"""
description: String = ""
"""
Name for the target deployment environment.
"""
environment: String = "production"
"""
JSON payload with extra information about the deployment.
"""
payload: String = "{}"
"""
The node ID of the ref to be deployed.
"""
refId: ID! @possibleTypes(concreteTypes: ["Ref"])
"""
The node ID of the repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
"""
The status contexts to verify against commit status checks. To bypass required
contexts, pass an empty array. Defaults to all unique contexts.
"""
requiredContexts: [String!]
"""
Specifies a task to execute.
"""
task: String = "deploy"
}
"""
Autogenerated return type of CreateDeployment
"""
type CreateDeploymentPayload @preview(toggledBy: "flash-preview") {
"""
True if the default branch has been auto-merged into the deployment ref.
"""
autoMerged: Boolean
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new deployment.
"""
deployment: Deployment
}
"""
Autogenerated input type of CreateDeploymentStatus
"""
input CreateDeploymentStatusInput @preview(toggledBy: "flash-preview") {
"""
Adds a new inactive status to all non-transient, non-production environment
deployments with the same repository and environment name as the created
status's deployment.
"""
autoInactive: Boolean = true
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The node ID of the deployment.
"""
deploymentId: ID! @possibleTypes(concreteTypes: ["Deployment"])
"""
A short description of the status. Maximum length of 140 characters.
"""
description: String = ""
"""
If provided, updates the environment of the deploy. Otherwise, does not modify the environment.
"""
environment: String
"""
Sets the URL for accessing your environment.
"""
environmentUrl: String = ""
"""
The log URL to associate with this status. This URL should contain
output to keep the user updated while the task is running or serve as
historical information for what happened in the deployment.
"""
logUrl: String = ""
"""
The state of the deployment.
"""
state: DeploymentStatusState!
}
"""
Autogenerated return type of CreateDeploymentStatus
"""
type CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new deployment status.
"""
deploymentStatus: DeploymentStatus
}
"""
Autogenerated input type of CreateDiscussion
"""
input CreateDiscussionInput {
"""
The body of the discussion.
"""
body: String!
"""
The id of the discussion category to associate with this discussion.
"""
categoryId: ID! @possibleTypes(concreteTypes: ["DiscussionCategory"])
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the repository on which to create the discussion.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
"""
The title of the discussion.
"""
title: String!
}
"""
Autogenerated return type of CreateDiscussion
"""
type CreateDiscussionPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The discussion that was just created.
"""
discussion: Discussion
}
"""
Autogenerated input type of CreateEnterpriseOrganization
"""
input CreateEnterpriseOrganizationInput {
"""
The logins for the administrators of the new organization.
"""
adminLogins: [String!]!
"""
The email used for sending billing receipts.
"""
billingEmail: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the enterprise owning the new organization.
"""
enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
The login of the new organization.
"""
login: String!
"""
The profile name of the new organization.
"""
profileName: String!
}
"""
Autogenerated return type of CreateEnterpriseOrganization
"""
type CreateEnterpriseOrganizationPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The enterprise that owns the created organization.
"""
enterprise: Enterprise
"""
The organization that was created.
"""
organization: Organization
}
"""
Autogenerated input type of CreateEnvironment
"""
input CreateEnvironmentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The name of the environment.
"""
name: String!
"""
The node ID of the repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
Autogenerated return type of CreateEnvironment
"""
type CreateEnvironmentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new or existing environment.
"""
environment: Environment
}
"""
Autogenerated input type of CreateIpAllowListEntry
"""
input CreateIpAllowListEntryInput {
"""
An IP address or range of addresses in CIDR notation.
"""
allowListValue: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Whether the IP allow list entry is active when an IP allow list is enabled.
"""
isActive: Boolean!
"""
An optional name for the IP allow list entry.
"""
name: String
"""
The ID of the owner for which to create the new IP allow list entry.
"""
ownerId: ID! @possibleTypes(concreteTypes: ["App", "Enterprise", "Organization"], abstractType: "IpAllowListOwner")
}
"""
Autogenerated return type of CreateIpAllowListEntry
"""
type CreateIpAllowListEntryPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The IP allow list entry that was created.
"""
ipAllowListEntry: IpAllowListEntry
}
"""
Autogenerated input type of CreateIssue
"""
input CreateIssueInput {
"""
The Node ID for the user assignee for this issue.
"""
assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"])
"""
The body for the issue description.
"""
body: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The name of an issue template in the repository, assigns labels and assignees from the template to the issue
"""
issueTemplate: String
"""
An array of Node IDs of labels for this issue.
"""
labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"])
"""
The Node ID of the milestone for this issue.
"""
milestoneId: ID @possibleTypes(concreteTypes: ["Milestone"])
"""
An array of Node IDs for projects associated with this issue.
"""
projectIds: [ID!] @possibleTypes(concreteTypes: ["Project"])
"""
The Node ID of the repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
"""
The title for the issue.
"""
title: String!
}
"""
Autogenerated return type of CreateIssue
"""
type CreateIssuePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new issue.
"""
issue: Issue
}
"""
Autogenerated input type of CreateLabel
"""
input CreateLabelInput @preview(toggledBy: "bane-preview") {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A 6 character hex code, without the leading #, identifying the color of the label.
"""
color: String!
"""
A brief description of the label, such as its purpose.
"""
description: String
"""
The name of the label.
"""
name: String!
"""
The Node ID of the repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
Autogenerated return type of CreateLabel
"""
type CreateLabelPayload @preview(toggledBy: "bane-preview") {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new label.
"""
label: Label
}
"""
Autogenerated input type of CreateProject
"""
input CreateProjectInput {
"""
The description of project.
"""
body: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The name of project.
"""
name: String!
"""
The owner ID to create the project under.
"""
ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository", "User"], abstractType: "ProjectOwner")
"""
A list of repository IDs to create as linked repositories for the project
"""
repositoryIds: [ID!] @possibleTypes(concreteTypes: ["Repository"])
"""
The name of the GitHub-provided template.
"""
template: ProjectTemplate
}
"""
Autogenerated return type of CreateProject
"""
type CreateProjectPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new project.
"""
project: Project
}
"""
Autogenerated input type of CreatePullRequest
"""
input CreatePullRequestInput {
"""
The name of the branch you want your changes pulled into. This should be an existing branch
on the current repository. You cannot update the base branch on a pull request to point
to another repository.
"""
baseRefName: String!
"""
The contents of the pull request.
"""
body: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Indicates whether this pull request should be a draft.
"""
draft: Boolean = false
"""
The name of the branch where your changes are implemented. For cross-repository pull requests
in the same network, namespace `head_ref_name` with a user like this: `username:branch`.
"""
headRefName: String!
"""
Indicates whether maintainers can modify the pull request.
"""
maintainerCanModify: Boolean = true
"""
The Node ID of the repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
"""
The title of the pull request.
"""
title: String!
}
"""
Autogenerated return type of CreatePullRequest
"""
type CreatePullRequestPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new pull request.
"""
pullRequest: PullRequest
}
"""
Autogenerated input type of CreateRef
"""
input CreateRefInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The fully qualified name of the new Ref (ie: `refs/heads/my_new_branch`).
"""
name: String!
"""
The GitObjectID that the new Ref shall target. Must point to a commit.
"""
oid: GitObjectID!
"""
The Node ID of the Repository to create the Ref in.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
Autogenerated return type of CreateRef
"""
type CreateRefPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The newly created ref.
"""
ref: Ref
}
"""
Autogenerated input type of CreateRepository
"""
input CreateRepositoryInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A short description of the new repository.
"""
description: String
"""
Indicates if the repository should have the issues feature enabled.
"""
hasIssuesEnabled: Boolean = true
"""
Indicates if the repository should have the wiki feature enabled.
"""
hasWikiEnabled: Boolean = false
"""
The URL for a web page about this repository.
"""
homepageUrl: URI
"""
The name of the new repository.
"""
name: String!
"""
The ID of the owner for the new repository.
"""
ownerId: ID @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "RepositoryOwner")
"""
When an organization is specified as the owner, this ID identifies the team
that should be granted access to the new repository.
"""
teamId: ID @possibleTypes(concreteTypes: ["Team"])
"""
Whether this repository should be marked as a template such that anyone who
can access it can create new repositories with the same files and directory structure.
"""
template: Boolean = false
"""
Indicates the repository's visibility level.
"""
visibility: RepositoryVisibility!
}
"""
Autogenerated return type of CreateRepository
"""
type CreateRepositoryPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new repository.
"""
repository: Repository
}
"""
Autogenerated input type of CreateSponsorship
"""
input CreateSponsorshipInput {
"""
The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000.
"""
amount: Int
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified.
"""
isRecurring: Boolean
"""
Specify whether others should be able to see that the sponsor is sponsoring
the sponsorable. Public visibility still does not reveal which tier is used.
"""
privacyLevel: SponsorshipPrivacy = PUBLIC
"""
Whether the sponsor should receive email updates from the sponsorable.
"""
receiveEmails: Boolean = true
"""
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
"""
The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified.
"""
tierId: ID @possibleTypes(concreteTypes: ["SponsorsTier"])
}
"""
Autogenerated return type of CreateSponsorship
"""
type CreateSponsorshipPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The sponsorship that was started.
"""
sponsorship: Sponsorship
}
"""
Autogenerated input type of CreateTeamDiscussionComment
"""
input CreateTeamDiscussionCommentInput {
"""
The content of the comment.
"""
body: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the discussion to which the comment belongs.
"""
discussionId: ID! @possibleTypes(concreteTypes: ["TeamDiscussion"])
}
"""
Autogenerated return type of CreateTeamDiscussionComment
"""
type CreateTeamDiscussionCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new comment.
"""
teamDiscussionComment: TeamDiscussionComment
}
"""
Autogenerated input type of CreateTeamDiscussion
"""
input CreateTeamDiscussionInput {
"""
The content of the discussion.
"""
body: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
If true, restricts the visibility of this discussion to team members and
organization admins. If false or not specified, allows any organization member
to view this discussion.
"""
private: Boolean
"""
The ID of the team to which the discussion belongs.
"""
teamId: ID! @possibleTypes(concreteTypes: ["Team"])
"""
The title of the discussion.
"""
title: String!
}
"""
Autogenerated return type of CreateTeamDiscussion
"""
type CreateTeamDiscussionPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new discussion.
"""
teamDiscussion: TeamDiscussion
}
"""
Represents the contribution a user made by committing to a repository.
"""
type CreatedCommitContribution implements Contribution {
"""
How many commits were made on this day to this repository by the user.
"""
commitCount: Int!
"""
Whether this contribution is associated with a record you do not have access to. For
example, your own 'first issue' contribution may have been made on a repository you can no
longer access.
"""
isRestricted: Boolean!
"""
When this contribution was made.
"""
occurredAt: DateTime!
"""
The repository the user made a commit in.
"""
repository: Repository!
"""
The HTTP path for this contribution.
"""
resourcePath: URI!
"""
The HTTP URL for this contribution.
"""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""
The connection type for CreatedCommitContribution.
"""
type CreatedCommitContributionConnection {
"""
A list of edges.
"""
edges: [CreatedCommitContributionEdge]
"""
A list of nodes.
"""
nodes: [CreatedCommitContribution]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of commits across days and repositories in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CreatedCommitContributionEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CreatedCommitContribution
}
"""
Represents the contribution a user made on GitHub by opening an issue.
"""
type CreatedIssueContribution implements Contribution {
"""
Whether this contribution is associated with a record you do not have access to. For
example, your own 'first issue' contribution may have been made on a repository you can no
longer access.
"""
isRestricted: Boolean!
"""
The issue that was opened.
"""
issue: Issue!
"""
When this contribution was made.
"""
occurredAt: DateTime!
"""
The HTTP path for this contribution.
"""
resourcePath: URI!
"""
The HTTP URL for this contribution.
"""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""
The connection type for CreatedIssueContribution.
"""
type CreatedIssueContributionConnection {
"""
A list of edges.
"""
edges: [CreatedIssueContributionEdge]
"""
A list of nodes.
"""
nodes: [CreatedIssueContribution]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CreatedIssueContributionEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CreatedIssueContribution
}
"""
Represents either a issue the viewer can access or a restricted contribution.
"""
union CreatedIssueOrRestrictedContribution = CreatedIssueContribution | RestrictedContribution
"""
Represents the contribution a user made on GitHub by opening a pull request.
"""
type CreatedPullRequestContribution implements Contribution {
"""
Whether this contribution is associated with a record you do not have access to. For
example, your own 'first issue' contribution may have been made on a repository you can no
longer access.
"""
isRestricted: Boolean!
"""
When this contribution was made.
"""
occurredAt: DateTime!
"""
The pull request that was opened.
"""
pullRequest: PullRequest!
"""
The HTTP path for this contribution.
"""
resourcePath: URI!
"""
The HTTP URL for this contribution.
"""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""
The connection type for CreatedPullRequestContribution.
"""
type CreatedPullRequestContributionConnection {
"""
A list of edges.
"""
edges: [CreatedPullRequestContributionEdge]
"""
A list of nodes.
"""
nodes: [CreatedPullRequestContribution]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CreatedPullRequestContributionEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CreatedPullRequestContribution
}
"""
Represents either a pull request the viewer can access or a restricted contribution.
"""
union CreatedPullRequestOrRestrictedContribution = CreatedPullRequestContribution | RestrictedContribution
"""
Represents the contribution a user made by leaving a review on a pull request.
"""
type CreatedPullRequestReviewContribution implements Contribution {
"""
Whether this contribution is associated with a record you do not have access to. For
example, your own 'first issue' contribution may have been made on a repository you can no
longer access.
"""
isRestricted: Boolean!
"""
When this contribution was made.
"""
occurredAt: DateTime!
"""
The pull request the user reviewed.
"""
pullRequest: PullRequest!
"""
The review the user left on the pull request.
"""
pullRequestReview: PullRequestReview!
"""
The repository containing the pull request that the user reviewed.
"""
repository: Repository!
"""
The HTTP path for this contribution.
"""
resourcePath: URI!
"""
The HTTP URL for this contribution.
"""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""
The connection type for CreatedPullRequestReviewContribution.
"""
type CreatedPullRequestReviewContributionConnection {
"""
A list of edges.
"""
edges: [CreatedPullRequestReviewContributionEdge]
"""
A list of nodes.
"""
nodes: [CreatedPullRequestReviewContribution]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CreatedPullRequestReviewContributionEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CreatedPullRequestReviewContribution
}
"""
Represents the contribution a user made on GitHub by creating a repository.
"""
type CreatedRepositoryContribution implements Contribution {
"""
Whether this contribution is associated with a record you do not have access to. For
example, your own 'first issue' contribution may have been made on a repository you can no
longer access.
"""
isRestricted: Boolean!
"""
When this contribution was made.
"""
occurredAt: DateTime!
"""
The repository that was created.
"""
repository: Repository!
"""
The HTTP path for this contribution.
"""
resourcePath: URI!
"""
The HTTP URL for this contribution.
"""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""
The connection type for CreatedRepositoryContribution.
"""
type CreatedRepositoryContributionConnection {
"""
A list of edges.
"""
edges: [CreatedRepositoryContributionEdge]
"""
A list of nodes.
"""
nodes: [CreatedRepositoryContribution]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CreatedRepositoryContributionEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: CreatedRepositoryContribution
}
"""
Represents either a repository the viewer can access or a restricted contribution.
"""
union CreatedRepositoryOrRestrictedContribution = CreatedRepositoryContribution | RestrictedContribution
"""
Represents a mention made by one issue or pull request to another.
"""
type CrossReferencedEvent implements Node & UniformResourceLocatable {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
Reference originated in a different repository.
"""
isCrossRepository: Boolean!
"""
Identifies when the reference was made.
"""
referencedAt: DateTime!
"""
The HTTP path for this pull request.
"""
resourcePath: URI!
"""
Issue or pull request that made the reference.
"""
source: ReferencedSubject!
"""
Issue or pull request to which the reference was made.
"""
target: ReferencedSubject!
"""
The HTTP URL for this pull request.
"""
url: URI!
"""
Checks if the target will be closed when the source is merged.
"""
willCloseTarget: Boolean!
}
"""
An ISO-8601 encoded date string.
"""
scalar Date
"""
An ISO-8601 encoded UTC date string.
"""
scalar DateTime
"""
Autogenerated input type of DeclineTopicSuggestion
"""
input DeclineTopicSuggestionInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The name of the suggested topic.
"""
name: String!
"""
The reason why the suggested topic is declined.
"""
reason: TopicSuggestionDeclineReason!
"""
The Node ID of the repository.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
Autogenerated return type of DeclineTopicSuggestion
"""
type DeclineTopicSuggestionPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The declined topic.
"""
topic: Topic
}
"""
The possible base permissions for repositories.
"""
enum DefaultRepositoryPermissionField {
"""
Can read, write, and administrate repos by default
"""
ADMIN
"""
No access
"""
NONE
"""
Can read repos by default
"""
READ
"""
Can read and write repos by default
"""
WRITE
}
"""
Entities that can be deleted.
"""
interface Deletable {
"""
Check if the current viewer can delete this object.
"""
viewerCanDelete: Boolean!
}
"""
Autogenerated input type of DeleteBranchProtectionRule
"""
input DeleteBranchProtectionRuleInput {
"""
The global relay id of the branch protection rule to be deleted.
"""
branchProtectionRuleId: ID! @possibleTypes(concreteTypes: ["BranchProtectionRule"])
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated return type of DeleteBranchProtectionRule
"""
type DeleteBranchProtectionRulePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of DeleteDeployment
"""
input DeleteDeploymentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the deployment to be deleted.
"""
id: ID! @possibleTypes(concreteTypes: ["Deployment"])
}
"""
Autogenerated return type of DeleteDeployment
"""
type DeleteDeploymentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of DeleteDiscussionComment
"""
input DeleteDiscussionCommentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node id of the discussion comment to delete.
"""
id: ID! @possibleTypes(concreteTypes: ["DiscussionComment"])
}
"""
Autogenerated return type of DeleteDiscussionComment
"""
type DeleteDiscussionCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The discussion comment that was just deleted.
"""
comment: DiscussionComment
}
"""
Autogenerated input type of DeleteDiscussion
"""
input DeleteDiscussionInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the discussion to delete.
"""
id: ID! @possibleTypes(concreteTypes: ["Discussion"])
}
"""
Autogenerated return type of DeleteDiscussion
"""
type DeleteDiscussionPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The discussion that was just deleted.
"""
discussion: Discussion
}
"""
Autogenerated input type of DeleteEnvironment
"""
input DeleteEnvironmentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the environment to be deleted.
"""
id: ID! @possibleTypes(concreteTypes: ["Environment"])
}
"""
Autogenerated return type of DeleteEnvironment
"""
type DeleteEnvironmentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of DeleteIpAllowListEntry
"""
input DeleteIpAllowListEntryInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the IP allow list entry to delete.
"""
ipAllowListEntryId: ID! @possibleTypes(concreteTypes: ["IpAllowListEntry"])
}
"""
Autogenerated return type of DeleteIpAllowListEntry
"""
type DeleteIpAllowListEntryPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The IP allow list entry that was deleted.
"""
ipAllowListEntry: IpAllowListEntry
}
"""
Autogenerated input type of DeleteIssueComment
"""
input DeleteIssueCommentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the comment to delete.
"""
id: ID! @possibleTypes(concreteTypes: ["IssueComment"])
}
"""
Autogenerated return type of DeleteIssueComment
"""
type DeleteIssueCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of DeleteIssue
"""
input DeleteIssueInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the issue to delete.
"""
issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
}
"""
Autogenerated return type of DeleteIssue
"""
type DeleteIssuePayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The repository the issue belonged to
"""
repository: Repository
}
"""
Autogenerated input type of DeleteLabel
"""
input DeleteLabelInput @preview(toggledBy: "bane-preview") {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the label to be deleted.
"""
id: ID! @possibleTypes(concreteTypes: ["Label"])
}
"""
Autogenerated return type of DeleteLabel
"""
type DeleteLabelPayload @preview(toggledBy: "bane-preview") {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of DeletePackageVersion
"""
input DeletePackageVersionInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the package version to be deleted.
"""
packageVersionId: ID! @possibleTypes(concreteTypes: ["PackageVersion"])
}
"""
Autogenerated return type of DeletePackageVersion
"""
type DeletePackageVersionPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Whether or not the operation succeeded.
"""
success: Boolean
}
"""
Autogenerated input type of DeleteProjectCard
"""
input DeleteProjectCardInput {
"""
The id of the card to delete.
"""
cardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated return type of DeleteProjectCard
"""
type DeleteProjectCardPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The column the deleted card was in.
"""
column: ProjectColumn
"""
The deleted card ID.
"""
deletedCardId: ID
}
"""
Autogenerated input type of DeleteProjectColumn
"""
input DeleteProjectColumnInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the column to delete.
"""
columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
}
"""
Autogenerated return type of DeleteProjectColumn
"""
type DeleteProjectColumnPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The deleted column ID.
"""
deletedColumnId: ID
"""
The project the deleted column was in.
"""
project: Project
}
"""
Autogenerated input type of DeleteProject
"""
input DeleteProjectInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Project ID to update.
"""
projectId: ID! @possibleTypes(concreteTypes: ["Project"])
}
"""
Autogenerated input type of DeleteProjectNextItem
"""
input DeleteProjectNextItemInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the item to be removed.
"""
itemId: ID! @possibleTypes(concreteTypes: ["ProjectNextItem"])
"""
The ID of the Project from which the item should be removed.
"""
projectId: ID! @possibleTypes(concreteTypes: ["ProjectNext"])
}
"""
Autogenerated return type of DeleteProjectNextItem
"""
type DeleteProjectNextItemPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the deleted item.
"""
deletedItemId: ID
}
"""
Autogenerated return type of DeleteProject
"""
type DeleteProjectPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The repository or organization the project was removed from.
"""
owner: ProjectOwner
}
"""
Autogenerated input type of DeletePullRequestReviewComment
"""
input DeletePullRequestReviewCommentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the comment to delete.
"""
id: ID! @possibleTypes(concreteTypes: ["PullRequestReviewComment"])
}
"""
Autogenerated return type of DeletePullRequestReviewComment
"""
type DeletePullRequestReviewCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The pull request review the deleted comment belonged to.
"""
pullRequestReview: PullRequestReview
}
"""
Autogenerated input type of DeletePullRequestReview
"""
input DeletePullRequestReviewInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the pull request review to delete.
"""
pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
}
"""
Autogenerated return type of DeletePullRequestReview
"""
type DeletePullRequestReviewPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The deleted pull request review.
"""
pullRequestReview: PullRequestReview
}
"""
Autogenerated input type of DeleteRef
"""
input DeleteRefInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the Ref to be deleted.
"""
refId: ID! @possibleTypes(concreteTypes: ["Ref"])
}
"""
Autogenerated return type of DeleteRef
"""
type DeleteRefPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of DeleteTeamDiscussionComment
"""
input DeleteTeamDiscussionCommentInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the comment to delete.
"""
id: ID! @possibleTypes(concreteTypes: ["TeamDiscussionComment"])
}
"""
Autogenerated return type of DeleteTeamDiscussionComment
"""
type DeleteTeamDiscussionCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of DeleteTeamDiscussion
"""
input DeleteTeamDiscussionInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The discussion ID to delete.
"""
id: ID! @possibleTypes(concreteTypes: ["TeamDiscussion"])
}
"""
Autogenerated return type of DeleteTeamDiscussion
"""
type DeleteTeamDiscussionPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of DeleteVerifiableDomain
"""
input DeleteVerifiableDomainInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the verifiable domain to delete.
"""
id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"])
}
"""
Autogenerated return type of DeleteVerifiableDomain
"""
type DeleteVerifiableDomainPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The owning account from which the domain was deleted.
"""
owner: VerifiableDomainOwner
}
"""
Represents a 'demilestoned' event on a given issue or pull request.
"""
type DemilestonedEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
Identifies the milestone title associated with the 'demilestoned' event.
"""
milestoneTitle: String!
"""
Object referenced by event.
"""
subject: MilestoneItem!
}
"""
A dependency manifest entry
"""
type DependencyGraphDependency @preview(toggledBy: "hawkgirl-preview") {
"""
Does the dependency itself have dependencies?
"""
hasDependencies: Boolean!
"""
The original name of the package, as it appears in the manifest.
"""
packageLabel: String!
"""
The dependency package manager
"""
packageManager: String
"""
The name of the package in the canonical form used by the package manager.
This may differ from the original textual form (see packageLabel), for example
in a package manager that uses case-insensitive comparisons.
"""
packageName: String!
"""
The repository containing the package
"""
repository: Repository
"""
The dependency version requirements
"""
requirements: String!
}
"""
The connection type for DependencyGraphDependency.
"""
type DependencyGraphDependencyConnection @preview(toggledBy: "hawkgirl-preview") {
"""
A list of edges.
"""
edges: [DependencyGraphDependencyEdge]
"""
A list of nodes.
"""
nodes: [DependencyGraphDependency]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DependencyGraphDependencyEdge @preview(toggledBy: "hawkgirl-preview") {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DependencyGraphDependency
}
"""
Dependency manifest for a repository
"""
type DependencyGraphManifest implements Node @preview(toggledBy: "hawkgirl-preview") {
"""
Path to view the manifest file blob
"""
blobPath: String!
"""
A list of manifest dependencies
"""
dependencies(
"""
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
): DependencyGraphDependencyConnection
"""
The number of dependencies listed in the manifest
"""
dependenciesCount: Int
"""
Is the manifest too big to parse?
"""
exceedsMaxSize: Boolean!
"""
Fully qualified manifest filename
"""
filename: String!
id: ID!
"""
Were we able to parse the manifest?
"""
parseable: Boolean!
"""
The repository containing the manifest
"""
repository: Repository!
}
"""
The connection type for DependencyGraphManifest.
"""
type DependencyGraphManifestConnection @preview(toggledBy: "hawkgirl-preview") {
"""
A list of edges.
"""
edges: [DependencyGraphManifestEdge]
"""
A list of nodes.
"""
nodes: [DependencyGraphManifest]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DependencyGraphManifestEdge @preview(toggledBy: "hawkgirl-preview") {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DependencyGraphManifest
}
"""
A repository deploy key.
"""
type DeployKey implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
The deploy key.
"""
key: String!
"""
Whether or not the deploy key is read only.
"""
readOnly: Boolean!
"""
The deploy key title.
"""
title: String!
"""
Whether or not the deploy key has been verified.
"""
verified: Boolean!
}
"""
The connection type for DeployKey.
"""
type DeployKeyConnection {
"""
A list of edges.
"""
edges: [DeployKeyEdge]
"""
A list of nodes.
"""
nodes: [DeployKey]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DeployKeyEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DeployKey
}
"""
Represents a 'deployed' event on a given pull request.
"""
type DeployedEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The deployment associated with the 'deployed' event.
"""
deployment: Deployment!
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
"""
The ref associated with the 'deployed' event.
"""
ref: Ref
}
"""
Represents triggered deployment instance.
"""
type Deployment implements Node {
"""
Identifies the commit sha of the deployment.
"""
commit: Commit
"""
Identifies the oid of the deployment commit, even if the commit has been deleted.
"""
commitOid: String!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the actor who triggered the deployment.
"""
creator: Actor!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The deployment description.
"""
description: String
"""
The latest environment to which this deployment was made.
"""
environment: String
id: ID!
"""
The latest environment to which this deployment was made.
"""
latestEnvironment: String
"""
The latest status of this deployment.
"""
latestStatus: DeploymentStatus
"""
The original environment to which this deployment was made.
"""
originalEnvironment: String
"""
Extra information that a deployment system might need.
"""
payload: String
"""
Identifies the Ref of the deployment, if the deployment was created by ref.
"""
ref: Ref
"""
Identifies the repository associated with the deployment.
"""
repository: Repository!
"""
The current state of the deployment.
"""
state: DeploymentState
"""
A list of statuses associated with the deployment.
"""
statuses(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): DeploymentStatusConnection
"""
The deployment task.
"""
task: String
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
}
"""
The connection type for Deployment.
"""
type DeploymentConnection {
"""
A list of edges.
"""
edges: [DeploymentEdge]
"""
A list of nodes.
"""
nodes: [Deployment]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DeploymentEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Deployment
}
"""
Represents a 'deployment_environment_changed' event on a given pull request.
"""
type DeploymentEnvironmentChangedEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The deployment status that updated the deployment environment.
"""
deploymentStatus: DeploymentStatus!
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
}
"""
Ordering options for deployment connections
"""
input DeploymentOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order deployments by.
"""
field: DeploymentOrderField!
}
"""
Properties by which deployment connections can be ordered.
"""
enum DeploymentOrderField {
"""
Order collection by creation time
"""
CREATED_AT
}
"""
A protection rule.
"""
type DeploymentProtectionRule {
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The teams or users that can review the deployment
"""
reviewers(
"""
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
): DeploymentReviewerConnection!
"""
The timeout in minutes for this protection rule.
"""
timeout: Int!
"""
The type of protection rule.
"""
type: DeploymentProtectionRuleType!
}
"""
The connection type for DeploymentProtectionRule.
"""
type DeploymentProtectionRuleConnection {
"""
A list of edges.
"""
edges: [DeploymentProtectionRuleEdge]
"""
A list of nodes.
"""
nodes: [DeploymentProtectionRule]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DeploymentProtectionRuleEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DeploymentProtectionRule
}
"""
The possible protection rule types.
"""
enum DeploymentProtectionRuleType {
"""
Required reviewers
"""
REQUIRED_REVIEWERS
"""
Wait timer
"""
WAIT_TIMER
}
"""
A request to deploy a workflow run to an environment.
"""
type DeploymentRequest {
"""
Whether or not the current user can approve the deployment
"""
currentUserCanApprove: Boolean!
"""
The target environment of the deployment
"""
environment: Environment!
"""
The teams or users that can review the deployment
"""
reviewers(
"""
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
): DeploymentReviewerConnection!
"""
The wait timer in minutes configured in the environment
"""
waitTimer: Int!
"""
The wait timer in minutes configured in the environment
"""
waitTimerStartedAt: DateTime
}
"""
The connection type for DeploymentRequest.
"""
type DeploymentRequestConnection {
"""
A list of edges.
"""
edges: [DeploymentRequestEdge]
"""
A list of nodes.
"""
nodes: [DeploymentRequest]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DeploymentRequestEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DeploymentRequest
}
"""
A deployment review.
"""
type DeploymentReview implements Node {
"""
The comment the user left.
"""
comment: String!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The environments approved or rejected
"""
environments(
"""
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
): EnvironmentConnection!
id: ID!
"""
The decision of the user.
"""
state: DeploymentReviewState!
"""
The user that reviewed the deployment.
"""
user: User!
}
"""
The connection type for DeploymentReview.
"""
type DeploymentReviewConnection {
"""
A list of edges.
"""
edges: [DeploymentReviewEdge]
"""
A list of nodes.
"""
nodes: [DeploymentReview]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DeploymentReviewEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DeploymentReview
}
"""
The possible states for a deployment review.
"""
enum DeploymentReviewState {
"""
The deployment was approved.
"""
APPROVED
"""
The deployment was rejected.
"""
REJECTED
}
"""
Users and teams.
"""
union DeploymentReviewer = Team | User
"""
The connection type for DeploymentReviewer.
"""
type DeploymentReviewerConnection {
"""
A list of edges.
"""
edges: [DeploymentReviewerEdge]
"""
A list of nodes.
"""
nodes: [DeploymentReviewer]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DeploymentReviewerEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DeploymentReviewer
}
"""
The possible states in which a deployment can be.
"""
enum DeploymentState {
"""
The pending deployment was not updated after 30 minutes.
"""
ABANDONED
"""
The deployment is currently active.
"""
ACTIVE
"""
An inactive transient deployment.
"""
DESTROYED
"""
The deployment experienced an error.
"""
ERROR
"""
The deployment has failed.
"""
FAILURE
"""
The deployment is inactive.
"""
INACTIVE
"""
The deployment is in progress.
"""
IN_PROGRESS
"""
The deployment is pending.
"""
PENDING
"""
The deployment has queued
"""
QUEUED
"""
The deployment is waiting.
"""
WAITING
}
"""
Describes the status of a given deployment attempt.
"""
type DeploymentStatus implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the actor who triggered the deployment.
"""
creator: Actor!
"""
Identifies the deployment associated with status.
"""
deployment: Deployment!
"""
Identifies the description of the deployment.
"""
description: String
"""
Identifies the environment of the deployment at the time of this deployment status
"""
environment: String @preview(toggledBy: "flash-preview")
"""
Identifies the environment URL of the deployment.
"""
environmentUrl: URI
id: ID!
"""
Identifies the log URL of the deployment.
"""
logUrl: URI
"""
Identifies the current state of the deployment.
"""
state: DeploymentStatusState!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
}
"""
The connection type for DeploymentStatus.
"""
type DeploymentStatusConnection {
"""
A list of edges.
"""
edges: [DeploymentStatusEdge]
"""
A list of nodes.
"""
nodes: [DeploymentStatus]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DeploymentStatusEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DeploymentStatus
}
"""
The possible states for a deployment status.
"""
enum DeploymentStatusState {
"""
The deployment experienced an error.
"""
ERROR
"""
The deployment has failed.
"""
FAILURE
"""
The deployment is inactive.
"""
INACTIVE
"""
The deployment is in progress.
"""
IN_PROGRESS
"""
The deployment is pending.
"""
PENDING
"""
The deployment is queued
"""
QUEUED
"""
The deployment was successful.
"""
SUCCESS
"""
The deployment is waiting.
"""
WAITING
}
"""
The possible sides of a diff.
"""
enum DiffSide {
"""
The left side of the diff.
"""
LEFT
"""
The right side of the diff.
"""
RIGHT
}
"""
Autogenerated input type of DisablePullRequestAutoMerge
"""
input DisablePullRequestAutoMergeInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
ID of the pull request to disable auto merge on.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
Autogenerated return type of DisablePullRequestAutoMerge
"""
type DisablePullRequestAutoMergePayload {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The pull request auto merge was disabled on.
"""
pullRequest: PullRequest
}
"""
Represents a 'disconnected' event on a given issue or pull request.
"""
type DisconnectedEvent 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!
"""
Reference originated in a different repository.
"""
isCrossRepository: Boolean!
"""
Issue or pull request from which the issue was disconnected.
"""
source: ReferencedSubject!
"""
Issue or pull request which was disconnected.
"""
subject: ReferencedSubject!
}
"""
A discussion in a repository.
"""
type Discussion implements Comment & Deletable & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & Updatable & Votable {
"""
Reason that the conversation was locked.
"""
activeLockReason: LockReason
"""
The comment chosen as this discussion's answer, if any.
"""
answer: DiscussionComment
"""
The time when a user chose this discussion's answer, if answered.
"""
answerChosenAt: DateTime
"""
The user who chose this discussion's answer, if answered.
"""
answerChosenBy: Actor
"""
The actor who authored the comment.
"""
author: Actor
"""
Author's association with the subject of the comment.
"""
authorAssociation: CommentAuthorAssociation!
"""
The main text of the discussion post.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The body rendered to text.
"""
bodyText: String!
"""
The category for this discussion.
"""
category: DiscussionCategory!
"""
The replies to the discussion.
"""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): DiscussionCommentConnection!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The actor who edited the comment.
"""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
A list of labels associated with the object.
"""
labels(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for labels returned from the connection.
"""
orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
): LabelConnection
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
`true` if the object is locked
"""
locked: Boolean!
"""
The number identifying this discussion within the repository.
"""
number: Int!
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
A list of reactions grouped by content left on the subject.
"""
reactionGroups: [ReactionGroup!]
"""
A list of Reactions left on the Issue.
"""
reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Allows filtering Reactions by emoji.
"""
content: ReactionContent
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Allows specifying the order in which reactions are returned.
"""
orderBy: ReactionOrder
): ReactionConnection!
"""
The repository associated with this node.
"""
repository: Repository!
"""
The path for this discussion.
"""
resourcePath: URI!
"""
The title of this discussion.
"""
title: String!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
Number of upvotes that this subject has received.
"""
upvoteCount: Int!
"""
The URL for this discussion.
"""
url: URI!
"""
A list of edits to this content.
"""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserContentEditConnection
"""
Check if the current viewer can delete this object.
"""
viewerCanDelete: Boolean!
"""
Can user react to this subject
"""
viewerCanReact: Boolean!
"""
Check if the viewer is able to change their subscription status for the repository.
"""
viewerCanSubscribe: Boolean!
"""
Check if the current viewer can update this object.
"""
viewerCanUpdate: Boolean!
"""
Whether or not the current user can add or remove an upvote on this subject.
"""
viewerCanUpvote: Boolean!
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
"""
Whether or not the current user has already upvoted this subject.
"""
viewerHasUpvoted: Boolean!
"""
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
viewerSubscription: SubscriptionState
}
"""
A category for discussions in a repository.
"""
type DiscussionCategory implements Node & RepositoryNode {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
A description of this category.
"""
description: String
"""
An emoji representing this category.
"""
emoji: String!
"""
This category's emoji rendered as HTML.
"""
emojiHTML: HTML!
id: ID!
"""
Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation.
"""
isAnswerable: Boolean!
"""
The name of this category.
"""
name: String!
"""
The repository associated with this node.
"""
repository: Repository!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
}
"""
The connection type for DiscussionCategory.
"""
type DiscussionCategoryConnection {
"""
A list of edges.
"""
edges: [DiscussionCategoryEdge]
"""
A list of nodes.
"""
nodes: [DiscussionCategory]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DiscussionCategoryEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DiscussionCategory
}
"""
A comment on a discussion.
"""
type DiscussionComment implements Comment & Deletable & Minimizable & Node & Reactable & Updatable & UpdatableComment & Votable {
"""
The actor who authored the comment.
"""
author: Actor
"""
Author's association with the subject of the comment.
"""
authorAssociation: CommentAuthorAssociation!
"""
The body as Markdown.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The body rendered to text.
"""
bodyText: String!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The time when this replied-to comment was deleted
"""
deletedAt: DateTime
"""
The discussion this comment was created in
"""
discussion: Discussion
"""
The actor who edited the comment.
"""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
Has this comment been chosen as the answer of its discussion?
"""
isAnswer: Boolean!
"""
Returns whether or not a comment has been minimized.
"""
isMinimized: Boolean!
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
Returns why the comment was minimized.
"""
minimizedReason: String
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
A list of reactions grouped by content left on the subject.
"""
reactionGroups: [ReactionGroup!]
"""
A list of Reactions left on the Issue.
"""
reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Allows filtering Reactions by emoji.
"""
content: ReactionContent
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Allows specifying the order in which reactions are returned.
"""
orderBy: ReactionOrder
): ReactionConnection!
"""
The threaded replies to this comment.
"""
replies(
"""
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
): DiscussionCommentConnection!
"""
The discussion comment this comment is a reply to
"""
replyTo: DiscussionComment
"""
The path for this discussion comment.
"""
resourcePath: URI!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
Number of upvotes that this subject has received.
"""
upvoteCount: Int!
"""
The URL for this discussion comment.
"""
url: URI!
"""
A list of edits to this content.
"""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserContentEditConnection
"""
Check if the current viewer can delete this object.
"""
viewerCanDelete: Boolean!
"""
Can the current user mark this comment as an answer?
"""
viewerCanMarkAsAnswer: Boolean!
"""
Check if the current viewer can minimize this object.
"""
viewerCanMinimize: Boolean!
"""
Can user react to this subject
"""
viewerCanReact: Boolean!
"""
Can the current user unmark this comment as an answer?
"""
viewerCanUnmarkAsAnswer: Boolean!
"""
Check if the current viewer can update this object.
"""
viewerCanUpdate: Boolean!
"""
Whether or not the current user can add or remove an upvote on this subject.
"""
viewerCanUpvote: Boolean!
"""
Reasons why the current viewer can not update this comment.
"""
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
"""
Whether or not the current user has already upvoted this subject.
"""
viewerHasUpvoted: Boolean!
}
"""
The connection type for DiscussionComment.
"""
type DiscussionCommentConnection {
"""
A list of edges.
"""
edges: [DiscussionCommentEdge]
"""
A list of nodes.
"""
nodes: [DiscussionComment]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DiscussionCommentEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: DiscussionComment
}
"""
The connection type for Discussion.
"""
type DiscussionConnection {
"""
A list of edges.
"""
edges: [DiscussionEdge]
"""
A list of nodes.
"""
nodes: [Discussion]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type DiscussionEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Discussion
}
"""
Ways in which lists of discussions can be ordered upon return.
"""
input DiscussionOrder {
"""
The direction in which to order discussions by the specified field.
"""
direction: OrderDirection!
"""
The field by which to order discussions.
"""
field: DiscussionOrderField!
}
"""
Properties by which discussion connections can be ordered.
"""
enum DiscussionOrderField {
"""
Order discussions by creation time.
"""
CREATED_AT
"""
Order discussions by most recent modification time.
"""
UPDATED_AT
}
"""
Autogenerated input type of DismissPullRequestReview
"""
input DismissPullRequestReviewInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The contents of the pull request review dismissal message.
"""
message: String!
"""
The Node ID of the pull request review to modify.
"""
pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
}
"""
Autogenerated return type of DismissPullRequestReview
"""
type DismissPullRequestReviewPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The dismissed pull request review.
"""
pullRequestReview: PullRequestReview
}
"""
The possible reasons that a Dependabot alert was dismissed.
"""
enum DismissReason {
"""
A fix has already been started
"""
FIX_STARTED
"""
This alert is inaccurate or incorrect
"""
INACCURATE
"""
Vulnerable code is not actually used
"""
NOT_USED
"""
No bandwidth to fix this
"""
NO_BANDWIDTH
"""
Risk is tolerable to this project
"""
TOLERABLE_RISK
}
"""
Autogenerated input type of DismissRepositoryVulnerabilityAlert
"""
input DismissRepositoryVulnerabilityAlertInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The reason the Dependabot alert is being dismissed.
"""
dismissReason: DismissReason!
"""
The Dependabot alert ID to dismiss.
"""
repositoryVulnerabilityAlertId: ID! @possibleTypes(concreteTypes: ["RepositoryVulnerabilityAlert"])
}
"""
Autogenerated return type of DismissRepositoryVulnerabilityAlert
"""
type DismissRepositoryVulnerabilityAlertPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Dependabot alert that was dismissed
"""
repositoryVulnerabilityAlert: RepositoryVulnerabilityAlert
}
"""
Specifies a review comment to be left with a Pull Request Review.
"""
input DraftPullRequestReviewComment {
"""
Body of the comment to leave.
"""
body: String!
"""
Path to the file being commented on.
"""
path: String!
"""
Position in the file to leave a comment on.
"""
position: Int!
}
"""
Specifies a review comment thread to be left with a Pull Request Review.
"""
input DraftPullRequestReviewThread {
"""
Body of the comment to leave.
"""
body: 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 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 input type of EnablePullRequestAutoMerge
"""
input EnablePullRequestAutoMergeInput {
"""
The email address to associate with this merge.
"""
authorEmail: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.
"""
commitBody: String
"""
Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.
"""
commitHeadline: String
"""
The merge method to use. If omitted, defaults to 'MERGE'
"""
mergeMethod: PullRequestMergeMethod = MERGE
"""
ID of the pull request to enable auto-merge on.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
Autogenerated return type of EnablePullRequestAutoMerge
"""
type EnablePullRequestAutoMergePayload {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The pull request auto-merge was enabled on.
"""
pullRequest: PullRequest
}
"""
An account to manage multiple organizations with consolidated policy and billing.
"""
type Enterprise implements Node {
"""
A URL pointing to the enterprise's public avatar.
"""
avatarUrl(
"""
The size of the resulting square image.
"""
size: Int
): URI!
"""
Enterprise billing informationย visible to enterprise billing managers.
"""
billingInfo: EnterpriseBillingInfo
"""
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 enterprise.
"""
description: String
"""
The description of the enterprise as HTML.
"""
descriptionHTML: HTML!
id: ID!
"""
The location of the enterprise.
"""
location: String
"""
A list of users who are members of this enterprise.
"""
members(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Only return members within the selected GitHub Enterprise deployment
"""
deployment: EnterpriseUserDeployment
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for members returned from the connection.
"""
orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC}
"""
Only return members within the organizations with these logins
"""
organizationLogins: [String!]
"""
The search string to look for.
"""
query: String
"""
The role of the user in the enterprise organization or server.
"""
role: EnterpriseUserAccountMembershipRole
): EnterpriseMemberConnection!
"""
The name of the enterprise.
"""
name: String!
"""
A list of organizations that belong to this enterprise.
"""
organizations(
"""
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 organizations returned from the connection.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The search string to look for.
"""
query: String
"""
The viewer's role in an organization.
"""
viewerOrganizationRole: RoleInOrganization
): OrganizationConnection!
"""
Enterprise information only visible to enterprise owners.
"""
ownerInfo: EnterpriseOwnerInfo
"""
The HTTP path for this enterprise.
"""
resourcePath: URI!
"""
The URL-friendly identifier for the enterprise.
"""
slug: String!
"""
The HTTP URL for this enterprise.
"""
url: URI!
"""
A list of user accounts on this enterprise.
"""
userAccounts(
"""
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
): EnterpriseUserAccountConnection!
"""
Is the current viewer an admin of this enterprise?
"""
viewerIsAdmin: Boolean!
"""
The URL of the enterprise website.
"""
websiteUrl: URI
}
"""
The connection type for User.
"""
type EnterpriseAdministratorConnection {
"""
A list of edges.
"""
edges: [EnterpriseAdministratorEdge]
"""
A list of nodes.
"""
nodes: [User]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
A User who is an administrator of an enterprise.
"""
type EnterpriseAdministratorEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: User
"""
The role of the administrator.
"""
role: EnterpriseAdministratorRole!
}
"""
An invitation for a user to become an owner or billing manager of an enterprise.
"""
type EnterpriseAdministratorInvitation implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The email of the person who was invited to the enterprise.
"""
email: String
"""
The enterprise the invitation is for.
"""
enterprise: Enterprise!
id: ID!
"""
The user who was invited to the enterprise.
"""
invitee: User
"""
The user who created the invitation.
"""
inviter: User
"""
The invitee's pending role in the enterprise (owner or billing_manager).
"""
role: EnterpriseAdministratorRole!
}
"""
The connection type for EnterpriseAdministratorInvitation.
"""
type EnterpriseAdministratorInvitationConnection {
"""
A list of edges.
"""
edges: [EnterpriseAdministratorInvitationEdge]
"""
A list of nodes.
"""
nodes: [EnterpriseAdministratorInvitation]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type EnterpriseAdministratorInvitationEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: EnterpriseAdministratorInvitation
}
"""
Ordering options for enterprise administrator invitation connections
"""
input EnterpriseAdministratorInvitationOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order enterprise administrator invitations by.
"""
field: EnterpriseAdministratorInvitationOrderField!
}
"""
Properties by which enterprise administrator invitation connections can be ordered.
"""
enum EnterpriseAdministratorInvitationOrderField {
"""
Order enterprise administrator member invitations by creation time
"""
CREATED_AT
}
"""
The possible administrator roles in an enterprise account.
"""
enum EnterpriseAdministratorRole {
"""
Represents a billing manager of the enterprise account.
"""
BILLING_MANAGER
"""
Represents an owner of the enterprise account.
"""
OWNER
}
"""
Metadata for an audit entry containing enterprise account information.
"""
interface EnterpriseAuditEntryData {
"""
The HTTP path for this enterprise.
"""
enterpriseResourcePath: URI
"""
The slug of the enterprise.
"""
enterpriseSlug: String
"""
The HTTP URL for this enterprise.
"""
enterpriseUrl: URI
}
"""
Enterprise billing information visible to enterprise billing managers and owners.
"""
type EnterpriseBillingInfo {
"""
The number of licenseable users/emails across the enterprise.
"""
allLicensableUsersCount: Int!
"""
The number of data packs used by all organizations owned by the enterprise.
"""
assetPacks: Int!
"""
The number of available seats across all owned organizations based on the unique number of billable users.
"""
availableSeats: Int!
@deprecated(
reason: "`availableSeats` will be replaced with `totalAvailableLicenses` to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC."
)
"""
The bandwidth quota in GB for all organizations owned by the enterprise.
"""
bandwidthQuota: Float!
"""
The bandwidth usage in GB for all organizations owned by the enterprise.
"""
bandwidthUsage: Float!
"""
The bandwidth usage as a percentage of the bandwidth quota.
"""
bandwidthUsagePercentage: Int!
"""
The total seats across all organizations owned by the enterprise.
"""
seats: Int!
@deprecated(
reason: "`seats` will be replaced with `totalLicenses` to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC."
)
"""
The storage quota in GB for all organizations owned by the enterprise.
"""
storageQuota: Float!
"""
The storage usage in GB for all organizations owned by the enterprise.
"""
storageUsage: Float!
"""
The storage usage as a percentage of the storage quota.
"""
storageUsagePercentage: Int!
"""
The number of available licenses across all owned organizations based on the unique number of billable users.
"""
totalAvailableLicenses: Int!
"""
The total number of licenses allocated.
"""
totalLicenses: Int!
}
"""
The possible values for the enterprise base repository permission setting.
"""
enum EnterpriseDefaultRepositoryPermissionSettingValue {
"""
Organization members will be able to clone, pull, push, and add new collaborators to all organization repositories.
"""
ADMIN
"""
Organization members will only be able to clone and pull public repositories.
"""
NONE
"""
Organizations in the enterprise choose base repository permissions for their members.
"""
NO_POLICY
"""
Organization members will be able to clone and pull all organization repositories.
"""
READ
"""
Organization members will be able to clone, pull, and push all organization repositories.
"""
WRITE
}
"""
The possible values for an enabled/disabled enterprise setting.
"""
enum EnterpriseEnabledDisabledSettingValue {
"""
The setting is disabled for organizations in the enterprise.
"""
DISABLED
"""
The setting is enabled for organizations in the enterprise.
"""
ENABLED
"""
There is no policy set for organizations in the enterprise.
"""
NO_POLICY
}
"""
The possible values for an enabled/no policy enterprise setting.
"""
enum EnterpriseEnabledSettingValue {
"""
The setting is enabled for organizations in the enterprise.
"""
ENABLED
"""
There is no policy set for organizations in the enterprise.
"""
NO_POLICY
}
"""
An identity provider configured to provision identities for an enterprise.
"""
type EnterpriseIdentityProvider implements Node {
"""
The digest algorithm used to sign SAML requests for the identity provider.
"""
digestMethod: SamlDigestAlgorithm
"""
The enterprise this identity provider belongs to.
"""
enterprise: Enterprise
"""
ExternalIdentities provisioned by this identity provider.
"""
externalIdentities(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Filter to external identities with valid org membership only
"""
membersOnly: Boolean
): ExternalIdentityConnection!
id: ID!
"""
The x509 certificate used by the identity provider to sign assertions and responses.
"""
idpCertificate: X509Certificate
"""
The Issuer Entity ID for the SAML identity provider.
"""
issuer: String
"""
Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.
"""
recoveryCodes: [String!]
"""
The signature algorithm used to sign SAML requests for the identity provider.
"""
signatureMethod: SamlSignatureAlgorithm
"""
The URL endpoint for the identity provider's SAML SSO.
"""
ssoUrl: URI
}
"""
An object that is a member of an enterprise.
"""
union EnterpriseMember = EnterpriseUserAccount | User
"""
The connection type for EnterpriseMember.
"""
type EnterpriseMemberConnection {
"""
A list of edges.
"""
edges: [EnterpriseMemberEdge]
"""
A list of nodes.
"""
nodes: [EnterpriseMember]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
A User who is a member of an enterprise through one or more organizations.
"""
type EnterpriseMemberEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
Whether the user does not have a license for the enterprise.
"""
isUnlicensed: Boolean! @deprecated(reason: "All members consume a license Removal on 2021-01-01 UTC.")
"""
The item at the end of the edge.
"""
node: EnterpriseMember
}
"""
Ordering options for enterprise member connections.
"""
input EnterpriseMemberOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order enterprise members by.
"""
field: EnterpriseMemberOrderField!
}
"""
Properties by which enterprise member connections can be ordered.
"""
enum EnterpriseMemberOrderField {
"""
Order enterprise members by creation time
"""
CREATED_AT
"""
Order enterprise members by login
"""
LOGIN
}
"""
The possible values for the enterprise members can create repositories setting.
"""
enum EnterpriseMembersCanCreateRepositoriesSettingValue {
"""
Members will be able to create public and private repositories.
"""
ALL
"""
Members will not be able to create public or private repositories.
"""
DISABLED
"""
Organization administrators choose whether to allow members to create repositories.
"""
NO_POLICY
"""
Members will be able to create only private repositories.
"""
PRIVATE
"""
Members will be able to create only public repositories.
"""
PUBLIC
}
"""
The possible values for the members can make purchases setting.
"""
enum EnterpriseMembersCanMakePurchasesSettingValue {
"""
The setting is disabled for organizations in the enterprise.
"""
DISABLED
"""
The setting is enabled for organizations in the enterprise.
"""
ENABLED
}
"""
The connection type for Organization.
"""
type EnterpriseOrganizationMembershipConnection {
"""
A list of edges.
"""
edges: [EnterpriseOrganizationMembershipEdge]
"""
A list of nodes.
"""
nodes: [Organization]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An enterprise organization that a user is a member of.
"""
type EnterpriseOrganizationMembershipEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Organization
"""
The role of the user in the enterprise membership.
"""
role: EnterpriseUserAccountMembershipRole!
}
"""
The connection type for User.
"""
type EnterpriseOutsideCollaboratorConnection {
"""
A list of edges.
"""
edges: [EnterpriseOutsideCollaboratorEdge]
"""
A list of nodes.
"""
nodes: [User]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
A User who is an outside collaborator of an enterprise through one or more organizations.
"""
type EnterpriseOutsideCollaboratorEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
Whether the outside collaborator does not have a license for the enterprise.
"""
isUnlicensed: Boolean! @deprecated(reason: "All outside collaborators consume a license Removal on 2021-01-01 UTC.")
"""
The item at the end of the edge.
"""
node: User
"""
The enterprise organization repositories this user is a member of.
"""
repositories(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for repositories.
"""
orderBy: RepositoryOrder = {field: NAME, direction: ASC}
): EnterpriseRepositoryInfoConnection!
}
"""
Enterprise information only visible to enterprise owners.
"""
type EnterpriseOwnerInfo {
"""
A list of all of the administrators for this enterprise.
"""
admins(
"""
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 administrators returned from the connection.
"""
orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC}
"""
The search string to look for.
"""
query: String
"""
The role to filter by.
"""
role: EnterpriseAdministratorRole
): EnterpriseAdministratorConnection!
"""
A list of users in the enterprise who currently have two-factor authentication disabled.
"""
affiliatedUsersWithTwoFactorDisabled(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserConnection!
"""
Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.
"""
affiliatedUsersWithTwoFactorDisabledExist: Boolean!
"""
The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.
"""
allowPrivateRepositoryForkingSetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided private repository forking setting value.
"""
allowPrivateRepositoryForkingSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
The setting value for base repository permissions for organizations in this enterprise.
"""
defaultRepositoryPermissionSetting: EnterpriseDefaultRepositoryPermissionSettingValue!
"""
A list of enterprise organizations configured with the provided base repository permission.
"""
defaultRepositoryPermissionSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The permission to find organizations for.
"""
value: DefaultRepositoryPermissionField!
): OrganizationConnection!
"""
A list of domains owned by the enterprise.
"""
domains(
"""
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
"""
Filter whether or not the domain is approved.
"""
isApproved: Boolean = null
"""
Filter whether or not the domain is verified.
"""
isVerified: Boolean = null
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for verifiable domains returned.
"""
orderBy: VerifiableDomainOrder = {field: DOMAIN, direction: ASC}
): VerifiableDomainConnection!
"""
Enterprise Server installations owned by the enterprise.
"""
enterpriseServerInstallations(
"""
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
"""
Whether or not to only return installations discovered via GitHub Connect.
"""
connectedOnly: Boolean = false
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for Enterprise Server installations returned.
"""
orderBy: EnterpriseServerInstallationOrder = {field: HOST_NAME, direction: ASC}
): EnterpriseServerInstallationConnection!
"""
The setting value for whether the enterprise has an IP allow list enabled.
"""
ipAllowListEnabledSetting: IpAllowListEnabledSettingValue!
"""
The IP addresses that are allowed to access resources owned by the enterprise.
"""
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 setting value for whether the enterprise has IP allow list configuration for installed GitHub Apps enabled.
"""
ipAllowListForInstalledAppsEnabledSetting: IpAllowListForInstalledAppsEnabledSettingValue!
"""
Whether or not the base repository permission is currently being updated.
"""
isUpdatingDefaultRepositoryPermission: Boolean!
"""
Whether the two-factor authentication requirement is currently being enforced.
"""
isUpdatingTwoFactorRequirement: Boolean!
"""
The setting value for whether organization members with admin permissions on a
repository can change repository visibility.
"""
membersCanChangeRepositoryVisibilitySetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided can change repository visibility setting value.
"""
membersCanChangeRepositoryVisibilitySettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
The setting value for whether members of organizations in the enterprise can create internal repositories.
"""
membersCanCreateInternalRepositoriesSetting: Boolean
"""
The setting value for whether members of organizations in the enterprise can create private repositories.
"""
membersCanCreatePrivateRepositoriesSetting: Boolean
"""
The setting value for whether members of organizations in the enterprise can create public repositories.
"""
membersCanCreatePublicRepositoriesSetting: Boolean
"""
The setting value for whether members of organizations in the enterprise can create repositories.
"""
membersCanCreateRepositoriesSetting: EnterpriseMembersCanCreateRepositoriesSettingValue
"""
A list of enterprise organizations configured with the provided repository creation setting value.
"""
membersCanCreateRepositoriesSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting to find organizations for.
"""
value: OrganizationMembersCanCreateRepositoriesSettingValue!
): OrganizationConnection!
"""
The setting value for whether members with admin permissions for repositories can delete issues.
"""
membersCanDeleteIssuesSetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided members can delete issues setting value.
"""
membersCanDeleteIssuesSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
The setting value for whether members with admin permissions for repositories can delete or transfer repositories.
"""
membersCanDeleteRepositoriesSetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided members can delete repositories setting value.
"""
membersCanDeleteRepositoriesSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
The setting value for whether members of organizations in the enterprise can invite outside collaborators.
"""
membersCanInviteCollaboratorsSetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided members can invite collaborators setting value.
"""
membersCanInviteCollaboratorsSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.
"""
membersCanMakePurchasesSetting: EnterpriseMembersCanMakePurchasesSettingValue!
"""
The setting value for whether members with admin permissions for repositories can update protected branches.
"""
membersCanUpdateProtectedBranchesSetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided members can update protected branches setting value.
"""
membersCanUpdateProtectedBranchesSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
The setting value for whether members can view dependency insights.
"""
membersCanViewDependencyInsightsSetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided members can view dependency insights setting value.
"""
membersCanViewDependencyInsightsSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
Indicates if email notification delivery for this enterprise is restricted to verified or approved domains.
"""
notificationDeliveryRestrictionEnabledSetting: NotificationRestrictionSettingValue!
"""
The OIDC Identity Provider for the enterprise.
"""
oidcProvider: OIDCProvider
"""
The setting value for whether organization projects are enabled for organizations in this enterprise.
"""
organizationProjectsSetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided organization projects setting value.
"""
organizationProjectsSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
A list of outside collaborators across the repositories in the enterprise.
"""
outsideCollaborators(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
The login of one specific outside collaborator.
"""
login: String
"""
Ordering options for outside collaborators returned from the connection.
"""
orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC}
"""
The search string to look for.
"""
query: String
"""
Only return outside collaborators on repositories with this visibility.
"""
visibility: RepositoryVisibility
): EnterpriseOutsideCollaboratorConnection!
"""
A list of pending administrator invitations for the enterprise.
"""
pendingAdminInvitations(
"""
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 pending enterprise administrator invitations returned from the connection.
"""
orderBy: EnterpriseAdministratorInvitationOrder = {field: CREATED_AT, direction: DESC}
"""
The search string to look for.
"""
query: String
"""
The role to filter by.
"""
role: EnterpriseAdministratorRole
): EnterpriseAdministratorInvitationConnection!
"""
A list of pending collaborator invitations across the repositories in the enterprise.
"""
pendingCollaboratorInvitations(
"""
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 pending repository collaborator invitations returned from the connection.
"""
orderBy: RepositoryInvitationOrder = {field: CREATED_AT, direction: DESC}
"""
The search string to look for.
"""
query: String
): RepositoryInvitationConnection!
"""
A list of pending collaborators across the repositories in the enterprise.
"""
pendingCollaborators(
"""
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 pending repository collaborator invitations returned from the connection.
"""
orderBy: RepositoryInvitationOrder = {field: CREATED_AT, direction: DESC}
"""
The search string to look for.
"""
query: String
): EnterprisePendingCollaboratorConnection!
@deprecated(
reason: "Repository invitations can now be associated with an email, not only an invitee. Use the `pendingCollaboratorInvitations` field instead. Removal on 2020-10-01 UTC."
)
"""
A list of pending member invitations for organizations in the enterprise.
"""
pendingMemberInvitations(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
The search string to look for.
"""
query: String
): EnterprisePendingMemberInvitationConnection!
"""
The setting value for whether repository projects are enabled in this enterprise.
"""
repositoryProjectsSetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided repository projects setting value.
"""
repositoryProjectsSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
The SAML Identity Provider for the enterprise.
"""
samlIdentityProvider: EnterpriseIdentityProvider
"""
A list of enterprise organizations configured with the SAML single sign-on setting value.
"""
samlIdentityProviderSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: IdentityProviderConfigurationState!
): OrganizationConnection!
"""
A list of members with a support entitlement.
"""
supportEntitlements(
"""
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 support entitlement users returned from the connection.
"""
orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC}
): EnterpriseMemberConnection!
"""
The setting value for whether team discussions are enabled for organizations in this enterprise.
"""
teamDiscussionsSetting: EnterpriseEnabledDisabledSettingValue!
"""
A list of enterprise organizations configured with the provided team discussions setting value.
"""
teamDiscussionsSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
"""
The setting value for whether the enterprise requires two-factor authentication for its organizations and users.
"""
twoFactorRequiredSetting: EnterpriseEnabledSettingValue!
"""
A list of enterprise organizations configured with the two-factor authentication setting value.
"""
twoFactorRequiredSettingOrganizations(
"""
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 organizations with this setting.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The setting value to find organizations for.
"""
value: Boolean!
): OrganizationConnection!
}
"""
The connection type for User.
"""
type EnterprisePendingCollaboratorConnection {
"""
A list of edges.
"""
edges: [EnterprisePendingCollaboratorEdge]
"""
A list of nodes.
"""
nodes: [User]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.
"""
type EnterprisePendingCollaboratorEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
Whether the invited collaborator does not have a license for the enterprise.
"""
isUnlicensed: Boolean! @deprecated(reason: "All pending collaborators consume a license Removal on 2021-01-01 UTC.")
"""
The item at the end of the edge.
"""
node: User
"""
The enterprise organization repositories this user is a member of.
"""
repositories(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for repositories.
"""
orderBy: RepositoryOrder = {field: NAME, direction: ASC}
): EnterpriseRepositoryInfoConnection!
}
"""
The connection type for OrganizationInvitation.
"""
type EnterprisePendingMemberInvitationConnection {
"""
A list of edges.
"""
edges: [EnterprisePendingMemberInvitationEdge]
"""
A list of nodes.
"""
nodes: [OrganizationInvitation]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
"""
Identifies the total count of unique users in the connection.
"""
totalUniqueUserCount: Int!
}
"""
An invitation to be a member in an enterprise organization.
"""
type EnterprisePendingMemberInvitationEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
Whether the invitation has a license for the enterprise.
"""
isUnlicensed: Boolean! @deprecated(reason: "All pending members consume a license Removal on 2020-07-01 UTC.")
"""
The item at the end of the edge.
"""
node: OrganizationInvitation
}
"""
A subset of repository information queryable from an enterprise.
"""
type EnterpriseRepositoryInfo implements Node {
id: ID!
"""
Identifies if the repository is private or internal.
"""
isPrivate: Boolean!
"""
The repository's name.
"""
name: String!
"""
The repository's name with owner.
"""
nameWithOwner: String!
}
"""
The connection type for EnterpriseRepositoryInfo.
"""
type EnterpriseRepositoryInfoConnection {
"""
A list of edges.
"""
edges: [EnterpriseRepositoryInfoEdge]
"""
A list of nodes.
"""
nodes: [EnterpriseRepositoryInfo]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type EnterpriseRepositoryInfoEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: EnterpriseRepositoryInfo
}
"""
An Enterprise Server installation.
"""
type EnterpriseServerInstallation implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The customer name to which the Enterprise Server installation belongs.
"""
customerName: String!
"""
The host name of the Enterprise Server installation.
"""
hostName: String!
id: ID!
"""
Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.
"""
isConnected: Boolean!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
User accounts on this Enterprise Server installation.
"""
userAccounts(
"""
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 Enterprise Server user accounts returned from the connection.
"""
orderBy: EnterpriseServerUserAccountOrder = {field: LOGIN, direction: ASC}
): EnterpriseServerUserAccountConnection!
"""
User accounts uploads for the Enterprise Server installation.
"""
userAccountsUploads(
"""
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 Enterprise Server user accounts uploads returned from the connection.
"""
orderBy: EnterpriseServerUserAccountsUploadOrder = {field: CREATED_AT, direction: DESC}
): EnterpriseServerUserAccountsUploadConnection!
}
"""
The connection type for EnterpriseServerInstallation.
"""
type EnterpriseServerInstallationConnection {
"""
A list of edges.
"""
edges: [EnterpriseServerInstallationEdge]
"""
A list of nodes.
"""
nodes: [EnterpriseServerInstallation]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type EnterpriseServerInstallationEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: EnterpriseServerInstallation
}
"""
Ordering options for Enterprise Server installation connections.
"""
input EnterpriseServerInstallationOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order Enterprise Server installations by.
"""
field: EnterpriseServerInstallationOrderField!
}
"""
Properties by which Enterprise Server installation connections can be ordered.
"""
enum EnterpriseServerInstallationOrderField {
"""
Order Enterprise Server installations by creation time
"""
CREATED_AT
"""
Order Enterprise Server installations by customer name
"""
CUSTOMER_NAME
"""
Order Enterprise Server installations by host name
"""
HOST_NAME
}
"""
A user account on an Enterprise Server installation.
"""
type EnterpriseServerUserAccount implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
User emails belonging to this user account.
"""
emails(
"""
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 Enterprise Server user account emails returned from the connection.
"""
orderBy: EnterpriseServerUserAccountEmailOrder = {field: EMAIL, direction: ASC}
): EnterpriseServerUserAccountEmailConnection!
"""
The Enterprise Server installation on which this user account exists.
"""
enterpriseServerInstallation: EnterpriseServerInstallation!
id: ID!
"""
Whether the user account is a site administrator on the Enterprise Server installation.
"""
isSiteAdmin: Boolean!
"""
The login of the user account on the Enterprise Server installation.
"""
login: String!
"""
The profile name of the user account on the Enterprise Server installation.
"""
profileName: String
"""
The date and time when the user account was created on the Enterprise Server installation.
"""
remoteCreatedAt: DateTime!
"""
The ID of the user account on the Enterprise Server installation.
"""
remoteUserId: Int!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
}
"""
The connection type for EnterpriseServerUserAccount.
"""
type EnterpriseServerUserAccountConnection {
"""
A list of edges.
"""
edges: [EnterpriseServerUserAccountEdge]
"""
A list of nodes.
"""
nodes: [EnterpriseServerUserAccount]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type EnterpriseServerUserAccountEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: EnterpriseServerUserAccount
}
"""
An email belonging to a user account on an Enterprise Server installation.
"""
type EnterpriseServerUserAccountEmail implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The email address.
"""
email: String!
id: ID!
"""
Indicates whether this is the primary email of the associated user account.
"""
isPrimary: Boolean!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The user account to which the email belongs.
"""
userAccount: EnterpriseServerUserAccount!
}
"""
The connection type for EnterpriseServerUserAccountEmail.
"""
type EnterpriseServerUserAccountEmailConnection {
"""
A list of edges.
"""
edges: [EnterpriseServerUserAccountEmailEdge]
"""
A list of nodes.
"""
nodes: [EnterpriseServerUserAccountEmail]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type EnterpriseServerUserAccountEmailEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: EnterpriseServerUserAccountEmail
}
"""
Ordering options for Enterprise Server user account email connections.
"""
input EnterpriseServerUserAccountEmailOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order emails by.
"""
field: EnterpriseServerUserAccountEmailOrderField!
}
"""
Properties by which Enterprise Server user account email connections can be ordered.
"""
enum EnterpriseServerUserAccountEmailOrderField {
"""
Order emails by email
"""
EMAIL
}
"""
Ordering options for Enterprise Server user account connections.
"""
input EnterpriseServerUserAccountOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order user accounts by.
"""
field: EnterpriseServerUserAccountOrderField!
}
"""
Properties by which Enterprise Server user account connections can be ordered.
"""
enum EnterpriseServerUserAccountOrderField {
"""
Order user accounts by login
"""
LOGIN
"""
Order user accounts by creation time on the Enterprise Server installation
"""
REMOTE_CREATED_AT
}
"""
A user accounts upload from an Enterprise Server installation.
"""
type EnterpriseServerUserAccountsUpload implements Node {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The enterprise to which this upload belongs.
"""
enterprise: Enterprise!
"""
The Enterprise Server installation for which this upload was generated.
"""
enterpriseServerInstallation: EnterpriseServerInstallation!
id: ID!
"""
The name of the file uploaded.
"""
name: String!
"""
The synchronization state of the upload
"""
syncState: EnterpriseServerUserAccountsUploadSyncState!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
}
"""
The connection type for EnterpriseServerUserAccountsUpload.
"""
type EnterpriseServerUserAccountsUploadConnection {
"""
A list of edges.
"""
edges: [EnterpriseServerUserAccountsUploadEdge]
"""
A list of nodes.
"""
nodes: [EnterpriseServerUserAccountsUpload]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type EnterpriseServerUserAccountsUploadEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: EnterpriseServerUserAccountsUpload
}
"""
Ordering options for Enterprise Server user accounts upload connections.
"""
input EnterpriseServerUserAccountsUploadOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order user accounts uploads by.
"""
field: EnterpriseServerUserAccountsUploadOrderField!
}
"""
Properties by which Enterprise Server user accounts upload connections can be ordered.
"""
enum EnterpriseServerUserAccountsUploadOrderField {
"""
Order user accounts uploads by creation time
"""
CREATED_AT
}
"""
Synchronization state of the Enterprise Server user accounts upload
"""
enum EnterpriseServerUserAccountsUploadSyncState {
"""
The synchronization of the upload failed.
"""
FAILURE
"""
The synchronization of the upload is pending.
"""
PENDING
"""
The synchronization of the upload succeeded.
"""
SUCCESS
}
"""
An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.
"""
type EnterpriseUserAccount implements Actor & Node {
"""
A URL pointing to the enterprise user account'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!
"""
The enterprise in which this user account exists.
"""
enterprise: Enterprise!
id: ID!
"""
An identifier for the enterprise user account, a login or email address
"""
login: String!
"""
The name of the enterprise user account
"""
name: String
"""
A list of enterprise organizations this user is a member of.
"""
organizations(
"""
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 organizations returned from the connection.
"""
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
The search string to look for.
"""
query: String
"""
The role of the user in the enterprise organization.
"""
role: EnterpriseUserAccountMembershipRole
): EnterpriseOrganizationMembershipConnection!
"""
The HTTP path for this user.
"""
resourcePath: URI!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The HTTP URL for this user.
"""
url: URI!
"""
The user within the enterprise.
"""
user: User
}
"""
The connection type for EnterpriseUserAccount.
"""
type EnterpriseUserAccountConnection {
"""
A list of edges.
"""
edges: [EnterpriseUserAccountEdge]
"""
A list of nodes.
"""
nodes: [EnterpriseUserAccount]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type EnterpriseUserAccountEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: EnterpriseUserAccount
}
"""
The possible roles for enterprise membership.
"""
enum EnterpriseUserAccountMembershipRole {
"""
The user is a member of the enterprise membership.
"""
MEMBER
"""
The user is an owner of the enterprise membership.
"""
OWNER
}
"""
The possible GitHub Enterprise deployments where this user can exist.
"""
enum EnterpriseUserDeployment {
"""
The user is part of a GitHub Enterprise Cloud deployment.
"""
CLOUD
"""
The user is part of a GitHub Enterprise Server deployment.
"""
SERVER
}
"""
An environment.
"""
type Environment implements Node {
"""
Identifies the primary key from the database.
"""
databaseId: Int
id: ID!
"""
The name of the environment
"""
name: String!
"""
The protection rules defined for this environment
"""
protectionRules(
"""
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
): DeploymentProtectionRuleConnection!
}
"""
The connection type for Environment.
"""
type EnvironmentConnection {
"""
A list of edges.
"""
edges: [EnvironmentEdge]
"""
A list of nodes.
"""
nodes: [Environment]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type EnvironmentEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Environment
}
"""
An external identity provisioned by SAML SSO or SCIM.
"""
type ExternalIdentity implements Node {
"""
The GUID for this identity
"""
guid: String!
id: ID!
"""
Organization invitation for this SCIM-provisioned external identity
"""
organizationInvitation: OrganizationInvitation
"""
SAML Identity attributes
"""
samlIdentity: ExternalIdentitySamlAttributes
"""
SCIM Identity attributes
"""
scimIdentity: ExternalIdentityScimAttributes
"""
User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.
"""
user: User
}
"""
The connection type for ExternalIdentity.
"""
type ExternalIdentityConnection {
"""
A list of edges.
"""
edges: [ExternalIdentityEdge]
"""
A list of nodes.
"""
nodes: [ExternalIdentity]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type ExternalIdentityEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: ExternalIdentity
}
"""
SAML attributes for the External Identity
"""
type ExternalIdentitySamlAttributes {
"""
The emails associated with the SAML identity
"""
emails: [UserEmailMetadata!]
"""
Family name of the SAML identity
"""
familyName: String
"""
Given name of the SAML identity
"""
givenName: String
"""
The groups linked to this identity in IDP
"""
groups: [String!]
"""
The NameID of the SAML identity
"""
nameId: String
"""
The userName of the SAML identity
"""
username: String
}
"""
SCIM attributes for the External Identity
"""
type ExternalIdentityScimAttributes {
"""
The emails associated with the SCIM identity
"""
emails: [UserEmailMetadata!]
"""
Family name of the SCIM identity
"""
familyName: String
"""
Given name of the SCIM identity
"""
givenName: String
"""
The groups linked to this identity in IDP
"""
groups: [String!]
"""
The userName of the SCIM identity
"""
username: String
}
"""
A command to add a file at the given path with the given contents as part of a
commit. Any existing file at that that path will be replaced.
"""
input FileAddition {
"""
The base64 encoded contents of the file
"""
contents: Base64String!
"""
The path in the repository where the file will be located
"""
path: String!
}
"""
A description of a set of changes to a file tree to be made as part of
a git commit, modeled as zero or more file `additions` and zero or more
file `deletions`.
Both fields are optional; omitting both will produce a commit with no
file changes.
`deletions` and `additions` describe changes to files identified
by their path in the git tree using unix-style path separators, i.e.
`/`. The root of a git tree is an empty string, so paths are not
slash-prefixed.
`path` values must be unique across all `additions` and `deletions`
provided. Any duplication will result in a validation error.
### Encoding
File contents must be provided in full for each `FileAddition`.
The `contents` of a `FileAddition` must be encoded using RFC 4648
compliant base64, i.e. correct padding is required and no characters
outside the standard alphabet may be used. Invalid base64
encoding will be rejected with a validation error.
The encoded contents may be binary.
For text files, no assumptions are made about the character encoding of
the file contents (after base64 decoding). No charset transcoding or
line-ending normalization will be performed; it is the client's
responsibility to manage the character encoding of files they provide.
However, for maximum compatibility we recommend using UTF-8 encoding
and ensuring that all files in a repository use a consistent
line-ending convention (`\n` or `\r\n`), and that all files end
with a newline.
### Modeling file changes
Each of the the five types of conceptual changes that can be made in a
git commit can be described using the `FileChanges` type as follows:
1. New file addition: create file `hello world\n` at path `docs/README.txt`:
{
"additions" [
{
"path": "docs/README.txt",
"contents": base64encode("hello world\n")
}
]
}
2. Existing file modification: change existing `docs/README.txt` to have new
content `new content here\n`:
{
"additions" [
{
"path": "docs/README.txt",
"contents": base64encode("new content here\n")
}
]
}
3. Existing file deletion: remove existing file `docs/README.txt`.
Note that the path is required to exist -- specifying a
path that does not exist on the given branch will abort the
commit and return an error.
{
"deletions" [
{
"path": "docs/README.txt"
}
]
}
4. File rename with no changes: rename `docs/README.txt` with
previous content `hello world\n` to the same content at
`newdocs/README.txt`:
{
"deletions" [
{
"path": "docs/README.txt",
}
],
"additions" [
{
"path": "newdocs/README.txt",
"contents": base64encode("hello world\n")
}
]
}
5. File rename with changes: rename `docs/README.txt` with
previous content `hello world\n` to a file at path
`newdocs/README.txt` with content `new contents\n`:
{
"deletions" [
{
"path": "docs/README.txt",
}
],
"additions" [
{
"path": "newdocs/README.txt",
"contents": base64encode("new contents\n")
}
]
}
"""
input FileChanges {
"""
File to add or change.
"""
additions: [FileAddition!] = []
"""
Files to delete.
"""
deletions: [FileDeletion!] = []
}
"""
A command to delete the file at the given path as part of a commit.
"""
input FileDeletion {
"""
The path to delete
"""
path: String!
}
"""
The possible viewed states of a file .
"""
enum FileViewedState {
"""
The file has new changes since last viewed.
"""
DISMISSED
"""
The file has not been marked as viewed.
"""
UNVIEWED
"""
The file has been marked as viewed.
"""
VIEWED
}
"""
Autogenerated input type of FollowUser
"""
input FollowUserInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
ID of the user to follow.
"""
userId: ID! @possibleTypes(concreteTypes: ["User"])
}
"""
Autogenerated return type of FollowUser
"""
type FollowUserPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The user that was followed.
"""
user: User
}
"""
The connection type for User.
"""
type FollowerConnection {
"""
A list of edges.
"""
edges: [UserEdge]
"""
A list of nodes.
"""
nodes: [User]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
The connection type for User.
"""
type FollowingConnection {
"""
A list of edges.
"""
edges: [UserEdge]
"""
A list of nodes.
"""
nodes: [User]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
A funding platform link for a repository.
"""
type FundingLink {
"""
The funding platform this link is for.
"""
platform: FundingPlatform!
"""
The configured URL for this funding link.
"""
url: URI!
}
"""
The possible funding platforms for repository funding links.
"""
enum FundingPlatform {
"""
Community Bridge funding platform.
"""
COMMUNITY_BRIDGE
"""
Custom funding platform.
"""
CUSTOM
"""
GitHub funding platform.
"""
GITHUB
"""
IssueHunt funding platform.
"""
ISSUEHUNT
"""
Ko-fi funding platform.
"""
KO_FI
"""
LFX Crowdfunding funding platform.
"""
LFX_CROWDFUNDING
"""
Liberapay funding platform.
"""
LIBERAPAY
"""
Open Collective funding platform.
"""
OPEN_COLLECTIVE
"""
Otechie funding platform.
"""
OTECHIE
"""
Patreon funding platform.
"""
PATREON
"""
Tidelift funding platform.
"""
TIDELIFT
}
"""
A generic hovercard context with a message and icon
"""
type GenericHovercardContext implements HovercardContext {
"""
A string describing this context
"""
message: String!
"""
An octicon to accompany this context
"""
octicon: String!
}
"""
A Gist.
"""
type Gist implements Node & Starrable & UniformResourceLocatable {
"""
A list of comments associated with the gist
"""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): GistCommentConnection!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The gist description.
"""
description: String
"""
The files in this gist.
"""
files(
"""
The maximum number of files to return.
"""
limit: Int = 10
"""
The oid of the files to return
"""
oid: GitObjectID
): [GistFile]
"""
A list of forks associated with the gist
"""
forks(
"""
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 gists returned from the connection
"""
orderBy: GistOrder
): GistConnection!
id: ID!
"""
Identifies if the gist is a fork.
"""
isFork: Boolean!
"""
Whether the gist is public or not.
"""
isPublic: Boolean!
"""
The gist name.
"""
name: String!
"""
The gist owner.
"""
owner: RepositoryOwner
"""
Identifies when the gist was last pushed to.
"""
pushedAt: DateTime
"""
The HTML path to this resource.
"""
resourcePath: URI!
"""
Returns a count of how many stargazers there are on this object
"""
stargazerCount: Int!
"""
A list of users who have starred this starrable.
"""
stargazers(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Order for connection
"""
orderBy: StarOrder
): StargazerConnection!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The HTTP URL for this Gist.
"""
url: URI!
"""
Returns a boolean indicating whether the viewing user has starred this starrable.
"""
viewerHasStarred: Boolean!
}
"""
Represents a comment on an Gist.
"""
type GistComment implements Comment & Deletable & Minimizable & Node & Updatable & UpdatableComment {
"""
The actor who authored the comment.
"""
author: Actor
"""
Author's association with the gist.
"""
authorAssociation: CommentAuthorAssociation!
"""
Identifies the comment body.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The body rendered to text.
"""
bodyText: String!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The actor who edited the comment.
"""
editor: Actor
"""
The associated gist.
"""
gist: Gist!
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
Returns whether or not a comment has been minimized.
"""
isMinimized: Boolean!
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
Returns why the comment was minimized.
"""
minimizedReason: String
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
A list of edits to this content.
"""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserContentEditConnection
"""
Check if the current viewer can delete this object.
"""
viewerCanDelete: Boolean!
"""
Check if the current viewer can minimize this object.
"""
viewerCanMinimize: Boolean!
"""
Check if the current viewer can update this object.
"""
viewerCanUpdate: Boolean!
"""
Reasons why the current viewer can not update this comment.
"""
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
}
"""
The connection type for GistComment.
"""
type GistCommentConnection {
"""
A list of edges.
"""
edges: [GistCommentEdge]
"""
A list of nodes.
"""
nodes: [GistComment]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type GistCommentEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: GistComment
}
"""
The connection type for Gist.
"""
type GistConnection {
"""
A list of edges.
"""
edges: [GistEdge]
"""
A list of nodes.
"""
nodes: [Gist]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type GistEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Gist
}
"""
A file in a gist.
"""
type GistFile {
"""
The file name encoded to remove characters that are invalid in URL paths.
"""
encodedName: String
"""
The gist file encoding.
"""
encoding: String
"""
The file extension from the file name.
"""
extension: String
"""
Indicates if this file is an image.
"""
isImage: Boolean!
"""
Whether the file's contents were truncated.
"""
isTruncated: Boolean!
"""
The programming language this file is written in.
"""
language: Language
"""
The gist file name.
"""
name: String
"""
The gist file size in bytes.
"""
size: Int
"""
UTF8 text data or null if the file is binary
"""
text(
"""
Optionally truncate the returned file to this length.
"""
truncate: Int
): String
}
"""
Ordering options for gist connections
"""
input GistOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order repositories by.
"""
field: GistOrderField!
}
"""
Properties by which gist connections can be ordered.
"""
enum GistOrderField {
"""
Order gists by creation time
"""
CREATED_AT
"""
Order gists by push time
"""
PUSHED_AT
"""
Order gists by update time
"""
UPDATED_AT
}
"""
The privacy of a Gist
"""
enum GistPrivacy {
"""
Gists that are public and secret
"""
ALL
"""
Public
"""
PUBLIC
"""
Secret
"""
SECRET
}
"""
Represents an actor in a Git commit (ie. an author or committer).
"""
type GitActor {
"""
A URL pointing to the author's public avatar.
"""
avatarUrl(
"""
The size of the resulting square image.
"""
size: Int
): URI!
"""
The timestamp of the Git action (authoring or committing).
"""
date: GitTimestamp
"""
The email in the Git commit.
"""
email: String
"""
The name in the Git commit.
"""
name: String
"""
The GitHub user corresponding to the email field. Null if no such user exists.
"""
user: User
}
"""
The connection type for GitActor.
"""
type GitActorConnection {
"""
A list of edges.
"""
edges: [GitActorEdge]
"""
A list of nodes.
"""
nodes: [GitActor]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type GitActorEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: GitActor
}
"""
Represents information about the GitHub instance.
"""
type GitHubMetadata {
"""
Returns a String that's a SHA of `github-services`
"""
gitHubServicesSha: GitObjectID!
"""
IP addresses that users connect to for git operations
"""
gitIpAddresses: [String!]
"""
IP addresses that service hooks are sent from
"""
hookIpAddresses: [String!]
"""
IP addresses that the importer connects from
"""
importerIpAddresses: [String!]
"""
Whether or not users are verified
"""
isPasswordAuthenticationVerifiable: Boolean!
"""
IP addresses for GitHub Pages' A records
"""
pagesIpAddresses: [String!]
}
"""
Represents a Git object.
"""
interface GitObject {
"""
An abbreviated version of the Git object ID
"""
abbreviatedOid: String!
"""
The HTTP path for this Git object
"""
commitResourcePath: URI!
"""
The HTTP URL for this Git object
"""
commitUrl: URI!
id: ID!
"""
The Git object ID
"""
oid: GitObjectID!
"""
The Repository the Git object belongs to
"""
repository: Repository!
}
"""
A Git object ID.
"""
scalar GitObjectID
"""
A fully qualified reference name (e.g. `refs/heads/master`).
"""
scalar GitRefname @preview(toggledBy: "update-refs-preview")
"""
Git SSH string
"""
scalar GitSSHRemote
"""
Information about a signature (GPG or S/MIME) on a Commit or Tag.
"""
interface GitSignature {
"""
Email used to sign this object.
"""
email: String!
"""
True if the signature is valid and verified by GitHub.
"""
isValid: Boolean!
"""
Payload for GPG signing object. Raw ODB object without the signature header.
"""
payload: String!
"""
ASCII-armored signature header from object.
"""
signature: String!
"""
GitHub user corresponding to the email signing this commit.
"""
signer: User
"""
The state of this signature. `VALID` if signature is valid and verified by
GitHub, otherwise represents reason why signature is considered invalid.
"""
state: GitSignatureState!
"""
True if the signature was made with GitHub's signing key.
"""
wasSignedByGitHub: Boolean!
}
"""
The state of a Git signature.
"""
enum GitSignatureState {
"""
The signing certificate or its chain could not be verified
"""
BAD_CERT
"""
Invalid email used for signing
"""
BAD_EMAIL
"""
Signing key expired
"""
EXPIRED_KEY
"""
Internal error - the GPG verification service misbehaved
"""
GPGVERIFY_ERROR
"""
Internal error - the GPG verification service is unavailable at the moment
"""
GPGVERIFY_UNAVAILABLE
"""
Invalid signature
"""
INVALID
"""
Malformed signature
"""
MALFORMED_SIG
"""
The usage flags for the key that signed this don't allow signing
"""
NOT_SIGNING_KEY
"""
Email used for signing not known to GitHub
"""
NO_USER
"""
Valid signature, though certificate revocation check failed
"""
OCSP_ERROR
"""
Valid signature, pending certificate revocation checking
"""
OCSP_PENDING
"""
One or more certificates in chain has been revoked
"""
OCSP_REVOKED
"""
Key used for signing not known to GitHub
"""
UNKNOWN_KEY
"""
Unknown signature type
"""
UNKNOWN_SIG_TYPE
"""
Unsigned
"""
UNSIGNED
"""
Email used for signing unverified on GitHub
"""
UNVERIFIED_EMAIL
"""
Valid signature and verified by GitHub
"""
VALID
}
"""
An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC.
"""
scalar GitTimestamp
"""
Represents a GPG signature on a Commit or Tag.
"""
type GpgSignature implements GitSignature {
"""
Email used to sign this object.
"""
email: String!
"""
True if the signature is valid and verified by GitHub.
"""
isValid: Boolean!
"""
Hex-encoded ID of the key that signed this object.
"""
keyId: String
"""
Payload for GPG signing object. Raw ODB object without the signature header.
"""
payload: String!
"""
ASCII-armored signature header from object.
"""
signature: String!
"""
GitHub user corresponding to the email signing this commit.
"""
signer: User
"""
The state of this signature. `VALID` if signature is valid and verified by
GitHub, otherwise represents reason why signature is considered invalid.
"""
state: GitSignatureState!
"""
True if the signature was made with GitHub's signing key.
"""
wasSignedByGitHub: Boolean!
}
"""
A string containing HTML code.
"""
scalar HTML
"""
Represents a 'head_ref_deleted' event on a given pull request.
"""
type HeadRefDeletedEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the Ref associated with the `head_ref_deleted` event.
"""
headRef: Ref
"""
Identifies the name of the Ref associated with the `head_ref_deleted` event.
"""
headRefName: String!
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
}
"""
Represents a 'head_ref_force_pushed' event on a given pull request.
"""
type HeadRefForcePushedEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the after commit SHA for the 'head_ref_force_pushed' event.
"""
afterCommit: Commit
"""
Identifies the before commit SHA for the 'head_ref_force_pushed' event.
"""
beforeCommit: Commit
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
"""
Identifies the fully qualified ref name for the 'head_ref_force_pushed' event.
"""
ref: Ref
}
"""
Represents a 'head_ref_restored' event on a given pull request.
"""
type HeadRefRestoredEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
}
"""
Detail needed to display a hovercard for a user
"""
type Hovercard {
"""
Each of the contexts for this hovercard
"""
contexts: [HovercardContext!]!
}
"""
An individual line of a hovercard
"""
interface HovercardContext {
"""
A string describing this context
"""
message: String!
"""
An octicon to accompany this context
"""
octicon: String!
}
"""
The possible states in which authentication can be configured with an identity provider.
"""
enum IdentityProviderConfigurationState {
"""
Authentication with an identity provider is configured but not enforced.
"""
CONFIGURED
"""
Authentication with an identity provider is configured and enforced.
"""
ENFORCED
"""
Authentication with an identity provider is not configured.
"""
UNCONFIGURED
}
"""
Autogenerated input type of ImportProject
"""
input ImportProjectInput {
"""
The description of Project.
"""
body: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A list of columns containing issues and pull requests.
"""
columnImports: [ProjectColumnImport!]!
"""
The name of Project.
"""
name: String!
"""
The name of the Organization or User to create the Project under.
"""
ownerName: String!
"""
Whether the Project is public or not.
"""
public: Boolean = false
}
"""
Autogenerated return type of ImportProject
"""
type ImportProjectPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new Project!
"""
project: Project
}
"""
Autogenerated input type of InviteEnterpriseAdmin
"""
input InviteEnterpriseAdminInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The email of the person to invite as an administrator.
"""
email: String
"""
The ID of the enterprise to which you want to invite an administrator.
"""
enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
The login of a user to invite as an administrator.
"""
invitee: String
"""
The role of the administrator.
"""
role: EnterpriseAdministratorRole
}
"""
Autogenerated return type of InviteEnterpriseAdmin
"""
type InviteEnterpriseAdminPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The created enterprise administrator invitation.
"""
invitation: EnterpriseAdministratorInvitation
}
"""
The possible values for the IP allow list enabled setting.
"""
enum IpAllowListEnabledSettingValue {
"""
The setting is disabled for the owner.
"""
DISABLED
"""
The setting is enabled for the owner.
"""
ENABLED
}
"""
An IP address or range of addresses that is allowed to access an owner's resources.
"""
type IpAllowListEntry implements Node {
"""
A single IP address or range of IP addresses in CIDR notation.
"""
allowListValue: String!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
Whether the entry is currently active.
"""
isActive: Boolean!
"""
The name of the IP allow list entry.
"""
name: String
"""
The owner of the IP allow list entry.
"""
owner: IpAllowListOwner!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
}
"""
The connection type for IpAllowListEntry.
"""
type IpAllowListEntryConnection {
"""
A list of edges.
"""
edges: [IpAllowListEntryEdge]
"""
A list of nodes.
"""
nodes: [IpAllowListEntry]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type IpAllowListEntryEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: IpAllowListEntry
}
"""
Ordering options for IP allow list entry connections.
"""
input IpAllowListEntryOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order IP allow list entries by.
"""
field: IpAllowListEntryOrderField!
}
"""
Properties by which IP allow list entry connections can be ordered.
"""
enum IpAllowListEntryOrderField {
"""
Order IP allow list entries by the allow list value.
"""
ALLOW_LIST_VALUE
"""
Order IP allow list entries by creation time.
"""
CREATED_AT
}
"""
The possible values for the IP allow list configuration for installed GitHub Apps setting.
"""
enum IpAllowListForInstalledAppsEnabledSettingValue {
"""
The setting is disabled for the owner.
"""
DISABLED
"""
The setting is enabled for the owner.
"""
ENABLED
}
"""
Types that can own an IP allow list.
"""
union IpAllowListOwner = App | Enterprise | Organization
"""
An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
"""
type Issue implements Assignable & Closable & Comment & Labelable & Lockable & Node & ProjectNextOwner & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
"""
Reason that the conversation was locked.
"""
activeLockReason: LockReason
"""
A list of Users assigned to this object.
"""
assignees(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserConnection!
"""
The actor who authored the comment.
"""
author: Actor
"""
Author's association with the subject of the comment.
"""
authorAssociation: CommentAuthorAssociation!
"""
Identifies the body of the issue.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The http path for this issue body
"""
bodyResourcePath: URI!
"""
Identifies the body of the issue rendered to text.
"""
bodyText: String!
"""
The http URL for this issue body
"""
bodyUrl: URI!
"""
`true` if the object is closed (definition of closed may depend on type)
"""
closed: Boolean!
"""
Identifies the date and time when the object was closed.
"""
closedAt: DateTime
"""
A list of comments associated with the Issue.
"""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for issue comments returned from the connection.
"""
orderBy: IssueCommentOrder
): IssueCommentConnection!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The actor who edited the comment.
"""
editor: Actor
"""
The hovercard information for this issue
"""
hovercard(
"""
Whether or not to include notification contexts
"""
includeNotificationContexts: Boolean = true
): Hovercard!
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
Indicates whether or not this issue is currently pinned to the repository issues list
"""
isPinned: Boolean
"""
Is this issue read by the viewer
"""
isReadByViewer: Boolean
"""
A list of labels associated with the object.
"""
labels(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for labels returned from the connection.
"""
orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
): LabelConnection
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
`true` if the object is locked
"""
locked: Boolean!
"""
Identifies the milestone associated with the issue.
"""
milestone: Milestone
"""
Identifies the issue number.
"""
number: Int!
"""
A list of Users that are participating in the Issue conversation.
"""
participants(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserConnection!
"""
List of project cards associated with this issue.
"""
projectCards(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
A list of archived states to filter the cards by
"""
archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): ProjectCardConnection!
"""
Find a project by project (beta) number.
"""
projectNext(
"""
The project (beta) number.
"""
number: Int!
): ProjectNext
"""
A list of project (beta) items under the owner.
"""
projectsNext(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
A project (beta) to search for under the the owner.
"""
query: String
"""
How to order the returned projects (beta).
"""
sortBy: ProjectNextOrderField = TITLE
): ProjectNextConnection!
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
A list of reactions grouped by content left on the subject.
"""
reactionGroups: [ReactionGroup!]
"""
A list of Reactions left on the Issue.
"""
reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Allows filtering Reactions by emoji.
"""
content: ReactionContent
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Allows specifying the order in which reactions are returned.
"""
orderBy: ReactionOrder
): ReactionConnection!
"""
The repository associated with this node.
"""
repository: Repository!
"""
The HTTP path for this issue
"""
resourcePath: URI!
"""
Identifies the state of the issue.
"""
state: IssueState!
"""
A list of events, comments, commits, etc. associated with the issue.
"""
timeline(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Allows filtering timeline events by a `since` timestamp.
"""
since: DateTime
): IssueTimelineConnection!
@deprecated(reason: "`timeline` will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.")
"""
A list of events, comments, commits, etc. associated with the issue.
"""
timelineItems(
"""
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
"""
Filter timeline items by type.
"""
itemTypes: [IssueTimelineItemsItemType!]
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Filter timeline items by a `since` timestamp.
"""
since: DateTime
"""
Skips the first _n_ elements in the list.
"""
skip: Int
): IssueTimelineItemsConnection!
"""
Identifies the issue title.
"""
title: String!
"""
Identifies the issue title rendered to HTML.
"""
titleHTML: String!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The HTTP URL for this issue
"""
url: URI!
"""
A list of edits to this content.
"""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserContentEditConnection
"""
Can user react to this subject
"""
viewerCanReact: Boolean!
"""
Check if the viewer is able to change their subscription status for the repository.
"""
viewerCanSubscribe: Boolean!
"""
Check if the current viewer can update this object.
"""
viewerCanUpdate: Boolean!
"""
Reasons why the current viewer can not update this comment.
"""
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
"""
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
viewerSubscription: SubscriptionState
}
"""
Represents a comment on an Issue.
"""
type IssueComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
"""
The actor who authored the comment.
"""
author: Actor
"""
Author's association with the subject of the comment.
"""
authorAssociation: CommentAuthorAssociation!
"""
The body as Markdown.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The body rendered to text.
"""
bodyText: String!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The actor who edited the comment.
"""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
Returns whether or not a comment has been minimized.
"""
isMinimized: Boolean!
"""
Identifies the issue associated with the comment.
"""
issue: Issue!
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
Returns why the comment was minimized.
"""
minimizedReason: String
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
Returns the pull request associated with the comment, if this comment was made on a
pull request.
"""
pullRequest: PullRequest
"""
A list of reactions grouped by content left on the subject.
"""
reactionGroups: [ReactionGroup!]
"""
A list of Reactions left on the Issue.
"""
reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Allows filtering Reactions by emoji.
"""
content: ReactionContent
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Allows specifying the order in which reactions are returned.
"""
orderBy: ReactionOrder
): ReactionConnection!
"""
The repository associated with this node.
"""
repository: Repository!
"""
The HTTP path for this issue comment
"""
resourcePath: URI!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The HTTP URL for this issue comment
"""
url: URI!
"""
A list of edits to this content.
"""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserContentEditConnection
"""
Check if the current viewer can delete this object.
"""
viewerCanDelete: Boolean!
"""
Check if the current viewer can minimize this object.
"""
viewerCanMinimize: Boolean!
"""
Can user react to this subject
"""
viewerCanReact: Boolean!
"""
Check if the current viewer can update this object.
"""
viewerCanUpdate: Boolean!
"""
Reasons why the current viewer can not update this comment.
"""
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
}
"""
The connection type for IssueComment.
"""
type IssueCommentConnection {
"""
A list of edges.
"""
edges: [IssueCommentEdge]
"""
A list of nodes.
"""
nodes: [IssueComment]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type IssueCommentEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: IssueComment
}
"""
Ways in which lists of issue comments can be ordered upon return.
"""
input IssueCommentOrder {
"""
The direction in which to order issue comments by the specified field.
"""
direction: OrderDirection!
"""
The field in which to order issue comments by.
"""
field: IssueCommentOrderField!
}
"""
Properties by which issue comment connections can be ordered.
"""
enum IssueCommentOrderField {
"""
Order issue comments by update time
"""
UPDATED_AT
}
"""
The connection type for Issue.
"""
type IssueConnection {
"""
A list of edges.
"""
edges: [IssueEdge]
"""
A list of nodes.
"""
nodes: [Issue]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
This aggregates issues opened by a user within one repository.
"""
type IssueContributionsByRepository {
"""
The issue contributions.
"""
contributions(
"""
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 contributions returned from the connection.
"""
orderBy: ContributionOrder = {direction: DESC}
): CreatedIssueContributionConnection!
"""
The repository in which the issues were opened.
"""
repository: Repository!
}
"""
An edge in a connection.
"""
type IssueEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Issue
}
"""
Ways in which to filter lists of issues.
"""
input IssueFilters {
"""
List issues assigned to given name. Pass in `null` for issues with no assigned
user, and `*` for issues assigned to any user.
"""
assignee: String
"""
List issues created by given name.
"""
createdBy: String
"""
List issues where the list of label names exist on the issue.
"""
labels: [String!]
"""
List issues where the given name is mentioned in the issue.
"""
mentioned: String
"""
List issues by given milestone argument. If an string representation of an
integer is passed, it should refer to a milestone by its number field. Pass in
`null` for issues with no milestone, and `*` for issues that are assigned to any milestone.
"""
milestone: String
"""
List issues that have been updated at or after the given date.
"""
since: DateTime
"""
List issues filtered by the list of states given.
"""
states: [IssueState!]
"""
List issues subscribed to by viewer.
"""
viewerSubscribed: Boolean = false
}
"""
Used for return value of Repository.issueOrPullRequest.
"""
union IssueOrPullRequest = Issue | PullRequest
"""
Ways in which lists of issues can be ordered upon return.
"""
input IssueOrder {
"""
The direction in which to order issues by the specified field.
"""
direction: OrderDirection!
"""
The field in which to order issues by.
"""
field: IssueOrderField!
}
"""
Properties by which issue connections can be ordered.
"""
enum IssueOrderField {
"""
Order issues by comment count
"""
COMMENTS
"""
Order issues by creation time
"""
CREATED_AT
"""
Order issues by update time
"""
UPDATED_AT
}
"""
The possible states of an issue.
"""
enum IssueState {
"""
An issue that has been closed
"""
CLOSED
"""
An issue that is still open
"""
OPEN
}
"""
A repository issue template.
"""
type IssueTemplate {
"""
The template purpose.
"""
about: String
"""
The suggested issue body.
"""
body: String
"""
The template name.
"""
name: String!
"""
The suggested issue title.
"""
title: String
}
"""
The connection type for IssueTimelineItem.
"""
type IssueTimelineConnection {
"""
A list of edges.
"""
edges: [IssueTimelineItemEdge]
"""
A list of nodes.
"""
nodes: [IssueTimelineItem]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An item in an issue timeline
"""
union IssueTimelineItem =
AssignedEvent
| ClosedEvent
| Commit
| CrossReferencedEvent
| DemilestonedEvent
| IssueComment
| LabeledEvent
| LockedEvent
| MilestonedEvent
| ReferencedEvent
| RenamedTitleEvent
| ReopenedEvent
| SubscribedEvent
| TransferredEvent
| UnassignedEvent
| UnlabeledEvent
| UnlockedEvent
| UnsubscribedEvent
| UserBlockedEvent
"""
An edge in a connection.
"""
type IssueTimelineItemEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: IssueTimelineItem
}
"""
An item in an issue timeline
"""
union IssueTimelineItems =
AddedToProjectEvent
| AssignedEvent
| ClosedEvent
| CommentDeletedEvent
| ConnectedEvent
| ConvertedNoteToIssueEvent
| ConvertedToDiscussionEvent
| CrossReferencedEvent
| DemilestonedEvent
| DisconnectedEvent
| IssueComment
| LabeledEvent
| LockedEvent
| MarkedAsDuplicateEvent
| MentionedEvent
| MilestonedEvent
| MovedColumnsInProjectEvent
| PinnedEvent
| ReferencedEvent
| RemovedFromProjectEvent
| RenamedTitleEvent
| ReopenedEvent
| SubscribedEvent
| TransferredEvent
| UnassignedEvent
| UnlabeledEvent
| UnlockedEvent
| UnmarkedAsDuplicateEvent
| UnpinnedEvent
| UnsubscribedEvent
| UserBlockedEvent
"""
The connection type for IssueTimelineItems.
"""
type IssueTimelineItemsConnection {
"""
A list of edges.
"""
edges: [IssueTimelineItemsEdge]
"""
Identifies the count of items after applying `before` and `after` filters.
"""
filteredCount: Int!
"""
A list of nodes.
"""
nodes: [IssueTimelineItems]
"""
Identifies the count of items after applying `before`/`after` filters and `first`/`last`/`skip` slicing.
"""
pageCount: Int!
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
"""
Identifies the date and time when the timeline was last updated.
"""
updatedAt: DateTime!
}
"""
An edge in a connection.
"""
type IssueTimelineItemsEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: IssueTimelineItems
}
"""
The possible item types found in a timeline.
"""
enum IssueTimelineItemsItemType {
"""
Represents a 'added_to_project' event on a given issue or pull request.
"""
ADDED_TO_PROJECT_EVENT
"""
Represents an 'assigned' event on any assignable object.
"""
ASSIGNED_EVENT
"""
Represents a 'closed' event on any `Closable`.
"""
CLOSED_EVENT
"""
Represents a 'comment_deleted' event on a given issue or pull request.
"""
COMMENT_DELETED_EVENT
"""
Represents a 'connected' event on a given issue or pull request.
"""
CONNECTED_EVENT
"""
Represents a 'converted_note_to_issue' event on a given issue or pull request.
"""
CONVERTED_NOTE_TO_ISSUE_EVENT
"""
Represents a 'converted_to_discussion' event on a given issue.
"""
CONVERTED_TO_DISCUSSION_EVENT
"""
Represents a mention made by one issue or pull request to another.
"""
CROSS_REFERENCED_EVENT
"""
Represents a 'demilestoned' event on a given issue or pull request.
"""
DEMILESTONED_EVENT
"""
Represents a 'disconnected' event on a given issue or pull request.
"""
DISCONNECTED_EVENT
"""
Represents a comment on an Issue.
"""
ISSUE_COMMENT
"""
Represents a 'labeled' event on a given issue or pull request.
"""
LABELED_EVENT
"""
Represents a 'locked' event on a given issue or pull request.
"""
LOCKED_EVENT
"""
Represents a 'marked_as_duplicate' event on a given issue or pull request.
"""
MARKED_AS_DUPLICATE_EVENT
"""
Represents a 'mentioned' event on a given issue or pull request.
"""
MENTIONED_EVENT
"""
Represents a 'milestoned' event on a given issue or pull request.
"""
MILESTONED_EVENT
"""
Represents a 'moved_columns_in_project' event on a given issue or pull request.
"""
MOVED_COLUMNS_IN_PROJECT_EVENT
"""
Represents a 'pinned' event on a given issue or pull request.
"""
PINNED_EVENT
"""
Represents a 'referenced' event on a given `ReferencedSubject`.
"""
REFERENCED_EVENT
"""
Represents a 'removed_from_project' event on a given issue or pull request.
"""
REMOVED_FROM_PROJECT_EVENT
"""
Represents a 'renamed' event on a given issue or pull request
"""
RENAMED_TITLE_EVENT
"""
Represents a 'reopened' event on any `Closable`.
"""
REOPENED_EVENT
"""
Represents a 'subscribed' event on a given `Subscribable`.
"""
SUBSCRIBED_EVENT
"""
Represents a 'transferred' event on a given issue or pull request.
"""
TRANSFERRED_EVENT
"""
Represents an 'unassigned' event on any assignable object.
"""
UNASSIGNED_EVENT
"""
Represents an 'unlabeled' event on a given issue or pull request.
"""
UNLABELED_EVENT
"""
Represents an 'unlocked' event on a given issue or pull request.
"""
UNLOCKED_EVENT
"""
Represents an 'unmarked_as_duplicate' event on a given issue or pull request.
"""
UNMARKED_AS_DUPLICATE_EVENT
"""
Represents an 'unpinned' event on a given issue or pull request.
"""
UNPINNED_EVENT
"""
Represents an 'unsubscribed' event on a given `Subscribable`.
"""
UNSUBSCRIBED_EVENT
"""
Represents a 'user_blocked' event on a given user.
"""
USER_BLOCKED_EVENT
}
"""
Represents a user signing up for a GitHub account.
"""
type JoinedGitHubContribution implements Contribution {
"""
Whether this contribution is associated with a record you do not have access to. For
example, your own 'first issue' contribution may have been made on a repository you can no
longer access.
"""
isRestricted: Boolean!
"""
When this contribution was made.
"""
occurredAt: DateTime!
"""
The HTTP path for this contribution.
"""
resourcePath: URI!
"""
The HTTP URL for this contribution.
"""
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"""
A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository.
"""
type Label implements Node {
"""
Identifies the label color.
"""
color: String!
"""
Identifies the date and time when the label was created.
"""
createdAt: DateTime
"""
A brief description of this label.
"""
description: String
id: ID!
"""
Indicates whether or not this is a default label.
"""
isDefault: Boolean!
"""
A list of issues associated with this label.
"""
issues(
"""
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
"""
Filtering options for issues returned from the connection.
"""
filterBy: IssueFilters
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
A list of label names to filter the pull requests by.
"""
labels: [String!]
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for issues returned from the connection.
"""
orderBy: IssueOrder
"""
A list of states to filter the issues by.
"""
states: [IssueState!]
): IssueConnection!
"""
Identifies the label name.
"""
name: String!
"""
A list of pull requests associated with this label.
"""
pullRequests(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
The base ref name to filter the pull requests by.
"""
baseRefName: 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
"""
The head ref name to filter the pull requests by.
"""
headRefName: String
"""
A list of label names to filter the pull requests by.
"""
labels: [String!]
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for pull requests returned from the connection.
"""
orderBy: IssueOrder
"""
A list of states to filter the pull requests by.
"""
states: [PullRequestState!]
): PullRequestConnection!
"""
The repository associated with this label.
"""
repository: Repository!
"""
The HTTP path for this label.
"""
resourcePath: URI!
"""
Identifies the date and time when the label was last updated.
"""
updatedAt: DateTime
"""
The HTTP URL for this label.
"""
url: URI!
}
"""
The connection type for Label.
"""
type LabelConnection {
"""
A list of edges.
"""
edges: [LabelEdge]
"""
A list of nodes.
"""
nodes: [Label]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type LabelEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Label
}
"""
Ways in which lists of labels can be ordered upon return.
"""
input LabelOrder {
"""
The direction in which to order labels by the specified field.
"""
direction: OrderDirection!
"""
The field in which to order labels by.
"""
field: LabelOrderField!
}
"""
Properties by which label connections can be ordered.
"""
enum LabelOrderField {
"""
Order labels by creation time
"""
CREATED_AT
"""
Order labels by name
"""
NAME
}
"""
An object that can have labels assigned to it.
"""
interface Labelable {
"""
A list of labels associated with the object.
"""
labels(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for labels returned from the connection.
"""
orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
): LabelConnection
}
"""
Represents a 'labeled' event on a given issue or pull request.
"""
type LabeledEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
Identifies the label associated with the 'labeled' event.
"""
label: Label!
"""
Identifies the `Labelable` associated with the event.
"""
labelable: Labelable!
}
"""
Represents a given language found in repositories.
"""
type Language implements Node {
"""
The color defined for the current language.
"""
color: String
id: ID!
"""
The name of the current language.
"""
name: String!
}
"""
A list of languages associated with the parent.
"""
type LanguageConnection {
"""
A list of edges.
"""
edges: [LanguageEdge]
"""
A list of nodes.
"""
nodes: [Language]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
"""
The total size in bytes of files written in that language.
"""
totalSize: Int!
}
"""
Represents the language of a repository.
"""
type LanguageEdge {
cursor: String!
node: Language!
"""
The number of bytes of code written in the language.
"""
size: Int!
}
"""
Ordering options for language connections.
"""
input LanguageOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order languages by.
"""
field: LanguageOrderField!
}
"""
Properties by which language connections can be ordered.
"""
enum LanguageOrderField {
"""
Order languages by the size of all files containing the language
"""
SIZE
}
"""
A repository's open source license
"""
type License implements Node {
"""
The full text of the license
"""
body: String!
"""
The conditions set by the license
"""
conditions: [LicenseRule]!
"""
A human-readable description of the license
"""
description: String
"""
Whether the license should be featured
"""
featured: Boolean!
"""
Whether the license should be displayed in license pickers
"""
hidden: Boolean!
id: ID!
"""
Instructions on how to implement the license
"""
implementation: String
"""
The lowercased SPDX ID of the license
"""
key: String!
"""
The limitations set by the license
"""
limitations: [LicenseRule]!
"""
The license full name specified by <https://spdx.org/licenses>
"""
name: String!
"""
Customary short name if applicable (e.g, GPLv3)
"""
nickname: String
"""
The permissions set by the license
"""
permissions: [LicenseRule]!
"""
Whether the license is a pseudo-license placeholder (e.g., other, no-license)
"""
pseudoLicense: Boolean!
"""
Short identifier specified by <https://spdx.org/licenses>
"""
spdxId: String
"""
URL to the license on <https://choosealicense.com>
"""
url: URI
}
"""
Describes a License's conditions, permissions, and limitations
"""
type LicenseRule {
"""
A description of the rule
"""
description: String!
"""
The machine-readable rule key
"""
key: String!
"""
The human-readable rule label
"""
label: String!
}
"""
Autogenerated input type of LinkRepositoryToProject
"""
input LinkRepositoryToProjectInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the Project to link to a Repository
"""
projectId: ID! @possibleTypes(concreteTypes: ["Project"])
"""
The ID of the Repository to link to a Project.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
Autogenerated return type of LinkRepositoryToProject
"""
type LinkRepositoryToProjectPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The linked Project.
"""
project: Project
"""
The linked Repository.
"""
repository: Repository
}
"""
Autogenerated input type of LockLockable
"""
input LockLockableInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
A reason for why the item will be locked.
"""
lockReason: LockReason
"""
ID of the item to be locked.
"""
lockableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Lockable")
}
"""
Autogenerated return type of LockLockable
"""
type LockLockablePayload {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The item that was locked.
"""
lockedRecord: Lockable
}
"""
The possible reasons that an issue or pull request was locked.
"""
enum LockReason {
"""
The issue or pull request was locked because the conversation was off-topic.
"""
OFF_TOPIC
"""
The issue or pull request was locked because the conversation was resolved.
"""
RESOLVED
"""
The issue or pull request was locked because the conversation was spam.
"""
SPAM
"""
The issue or pull request was locked because the conversation was too heated.
"""
TOO_HEATED
}
"""
An object that can be locked.
"""
interface Lockable {
"""
Reason that the conversation was locked.
"""
activeLockReason: LockReason
"""
`true` if the object is locked
"""
locked: Boolean!
}
"""
Represents a 'locked' event on a given issue or pull request.
"""
type LockedEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
Reason that the conversation was locked (optional).
"""
lockReason: LockReason
"""
Object that was locked.
"""
lockable: Lockable!
}
"""
A placeholder user for attribution of imported data on GitHub.
"""
type Mannequin 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!
"""
The user that has claimed the data attributed to this mannequin.
"""
claimant: User
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The mannequin's email on the source instance.
"""
email: String
id: ID!
"""
The username of the actor.
"""
login: String!
"""
The HTML path to this resource.
"""
resourcePath: URI!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The URL to this resource.
"""
url: URI!
}
"""
Autogenerated input type of MarkDiscussionCommentAsAnswer
"""
input MarkDiscussionCommentAsAnswerInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the discussion comment to mark as an answer.
"""
id: ID! @possibleTypes(concreteTypes: ["DiscussionComment"])
}
"""
Autogenerated return type of MarkDiscussionCommentAsAnswer
"""
type MarkDiscussionCommentAsAnswerPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The discussion that includes the chosen comment.
"""
discussion: Discussion
}
"""
Autogenerated input type of MarkFileAsViewed
"""
input MarkFileAsViewedInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The path of the file to mark as viewed
"""
path: String!
"""
The Node ID of the pull request.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
Autogenerated return type of MarkFileAsViewed
"""
type MarkFileAsViewedPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The updated pull request.
"""
pullRequest: PullRequest
}
"""
Autogenerated input type of MarkPullRequestReadyForReview
"""
input MarkPullRequestReadyForReviewInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
ID of the pull request to be marked as ready for review.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
Autogenerated return type of MarkPullRequestReadyForReview
"""
type MarkPullRequestReadyForReviewPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The pull request that is ready for review.
"""
pullRequest: PullRequest
}
"""
Represents a 'marked_as_duplicate' event on a given issue or pull request.
"""
type MarkedAsDuplicateEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
The authoritative issue or pull request which has been duplicated by another.
"""
canonical: IssueOrPullRequest
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
The issue or pull request which has been marked as a duplicate of another.
"""
duplicate: IssueOrPullRequest
id: ID!
"""
Canonical and duplicate belong to different repositories.
"""
isCrossRepository: Boolean!
}
"""
A public description of a Marketplace category.
"""
type MarketplaceCategory implements Node {
"""
The category's description.
"""
description: String
"""
The technical description of how apps listed in this category work with GitHub.
"""
howItWorks: String
id: ID!
"""
The category's name.
"""
name: String!
"""
How many Marketplace listings have this as their primary category.
"""
primaryListingCount: Int!
"""
The HTTP path for this Marketplace category.
"""
resourcePath: URI!
"""
How many Marketplace listings have this as their secondary category.
"""
secondaryListingCount: Int!
"""
The short name of the category used in its URL.
"""
slug: String!
"""
The HTTP URL for this Marketplace category.
"""
url: URI!
}
"""
A listing in the GitHub integration marketplace.
"""
type MarketplaceListing implements Node {
"""
The GitHub App this listing represents.
"""
app: App
"""
URL to the listing owner's company site.
"""
companyUrl: URI
"""
The HTTP path for configuring access to the listing's integration or OAuth app
"""
configurationResourcePath: URI!
"""
The HTTP URL for configuring access to the listing's integration or OAuth app
"""
configurationUrl: URI!
"""
URL to the listing's documentation.
"""
documentationUrl: URI
"""
The listing's detailed description.
"""
extendedDescription: String
"""
The listing's detailed description rendered to HTML.
"""
extendedDescriptionHTML: HTML!
"""
The listing's introductory description.
"""
fullDescription: String!
"""
The listing's introductory description rendered to HTML.
"""
fullDescriptionHTML: HTML!
"""
Does this listing have any plans with a free trial?
"""
hasPublishedFreeTrialPlans: Boolean!
"""
Does this listing have a terms of service link?
"""
hasTermsOfService: Boolean!
"""
Whether the creator of the app is a verified org
"""
hasVerifiedOwner: Boolean!
"""
A technical description of how this app works with GitHub.
"""
howItWorks: String
"""
The listing's technical description rendered to HTML.
"""
howItWorksHTML: HTML!
id: ID!
"""
URL to install the product to the viewer's account or organization.
"""
installationUrl: URI
"""
Whether this listing's app has been installed for the current viewer
"""
installedForViewer: Boolean!
"""
Whether this listing has been removed from the Marketplace.
"""
isArchived: Boolean!
"""
Whether this listing is still an editable draft that has not been submitted
for review and is not publicly visible in the Marketplace.
"""
isDraft: Boolean!
"""
Whether the product this listing represents is available as part of a paid plan.
"""
isPaid: Boolean!
"""
Whether this listing has been approved for display in the Marketplace.
"""
isPublic: Boolean!
"""
Whether this listing has been rejected by GitHub for display in the Marketplace.
"""
isRejected: Boolean!
"""
Whether this listing has been approved for unverified display in the Marketplace.
"""
isUnverified: Boolean!
"""
Whether this draft listing has been submitted for review for approval to be unverified in the Marketplace.
"""
isUnverifiedPending: Boolean!
"""
Whether this draft listing has been submitted for review from GitHub for approval to be verified in the Marketplace.
"""
isVerificationPendingFromDraft: Boolean!
"""
Whether this unverified listing has been submitted for review from GitHub for approval to be verified in the Marketplace.
"""
isVerificationPendingFromUnverified: Boolean!
"""
Whether this listing has been approved for verified display in the Marketplace.
"""
isVerified: Boolean!
"""
The hex color code, without the leading '#', for the logo background.
"""
logoBackgroundColor: String!
"""
URL for the listing's logo image.
"""
logoUrl(
"""
The size in pixels of the resulting square image.
"""
size: Int = 400
): URI
"""
The listing's full name.
"""
name: String!
"""
The listing's very short description without a trailing period or ampersands.
"""
normalizedShortDescription: String!
"""
URL to the listing's detailed pricing.
"""
pricingUrl: URI
"""
The category that best describes the listing.
"""
primaryCategory: MarketplaceCategory!
"""
URL to the listing's privacy policy, may return an empty string for listings that do not require a privacy policy URL.
"""
privacyPolicyUrl: URI!
"""
The HTTP path for the Marketplace listing.
"""
resourcePath: URI!
"""
The URLs for the listing's screenshots.
"""
screenshotUrls: [String]!
"""
An alternate category that describes the listing.
"""
secondaryCategory: MarketplaceCategory
"""
The listing's very short description.
"""
shortDescription: String!
"""
The short name of the listing used in its URL.
"""
slug: String!
"""
URL to the listing's status page.
"""
statusUrl: URI
"""
An email address for support for this listing's app.
"""
supportEmail: String
"""
Either a URL or an email address for support for this listing's app, may
return an empty string for listings that do not require a support URL.
"""
supportUrl: URI!
"""
URL to the listing's terms of service.
"""
termsOfServiceUrl: URI
"""
The HTTP URL for the Marketplace listing.
"""
url: URI!
"""
Can the current viewer add plans for this Marketplace listing.
"""
viewerCanAddPlans: Boolean!
"""
Can the current viewer approve this Marketplace listing.
"""
viewerCanApprove: Boolean!
"""
Can the current viewer delist this Marketplace listing.
"""
viewerCanDelist: Boolean!
"""
Can the current viewer edit this Marketplace listing.
"""
viewerCanEdit: Boolean!
"""
Can the current viewer edit the primary and secondary category of this
Marketplace listing.
"""
viewerCanEditCategories: Boolean!
"""
Can the current viewer edit the plans for this Marketplace listing.
"""
viewerCanEditPlans: Boolean!
"""
Can the current viewer return this Marketplace listing to draft state
so it becomes editable again.
"""
viewerCanRedraft: Boolean!
"""
Can the current viewer reject this Marketplace listing by returning it to
an editable draft state or rejecting it entirely.
"""
viewerCanReject: Boolean!
"""
Can the current viewer request this listing be reviewed for display in
the Marketplace as verified.
"""
viewerCanRequestApproval: Boolean!
"""
Indicates whether the current user has an active subscription to this Marketplace listing.
"""
viewerHasPurchased: Boolean!
"""
Indicates if the current user has purchased a subscription to this Marketplace listing
for all of the organizations the user owns.
"""
viewerHasPurchasedForAllOrganizations: Boolean!
"""
Does the current viewer role allow them to administer this Marketplace listing.
"""
viewerIsListingAdmin: Boolean!
}
"""
Look up Marketplace Listings
"""
type MarketplaceListingConnection {
"""
A list of edges.
"""
edges: [MarketplaceListingEdge]
"""
A list of nodes.
"""
nodes: [MarketplaceListing]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type MarketplaceListingEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: MarketplaceListing
}
"""
Entities that have members who can set status messages.
"""
interface MemberStatusable {
"""
Get the status messages members of this entity have set that are either public or visible only to the organization.
"""
memberStatuses(
"""
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 user statuses returned from the connection.
"""
orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
): UserStatusConnection!
}
"""
Audit log entry for a members_can_delete_repos.clear event.
"""
type MembersCanDeleteReposClearAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData {
"""
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 HTTP path for this enterprise.
"""
enterpriseResourcePath: URI
"""
The slug of the enterprise.
"""
enterpriseSlug: String
"""
The HTTP URL for this enterprise.
"""
enterpriseUrl: URI
id: ID!
"""
The corresponding operation type for the action
"""
operationType: OperationType
"""
The Organization associated with the Audit Entry.
"""
organization: Organization
"""
The name of the Organization.
"""
organizationName: String
"""
The HTTP path for the organization
"""
organizationResourcePath: URI
"""
The HTTP URL for the organization
"""
organizationUrl: URI
"""
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
}
"""
Audit log entry for a members_can_delete_repos.disable event.
"""
type MembersCanDeleteReposDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData {
"""
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 HTTP path for this enterprise.
"""
enterpriseResourcePath: URI
"""
The slug of the enterprise.
"""
enterpriseSlug: String
"""
The HTTP URL for this enterprise.
"""
enterpriseUrl: URI
id: ID!
"""
The corresponding operation type for the action
"""
operationType: OperationType
"""
The Organization associated with the Audit Entry.
"""
organization: Organization
"""
The name of the Organization.
"""
organizationName: String
"""
The HTTP path for the organization
"""
organizationResourcePath: URI
"""
The HTTP URL for the organization
"""
organizationUrl: URI
"""
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
}
"""
Audit log entry for a members_can_delete_repos.enable event.
"""
type MembersCanDeleteReposEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData {
"""
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 HTTP path for this enterprise.
"""
enterpriseResourcePath: URI
"""
The slug of the enterprise.
"""
enterpriseSlug: String
"""
The HTTP URL for this enterprise.
"""
enterpriseUrl: URI
id: ID!
"""
The corresponding operation type for the action
"""
operationType: OperationType
"""
The Organization associated with the Audit Entry.
"""
organization: Organization
"""
The name of the Organization.
"""
organizationName: String
"""
The HTTP path for the organization
"""
organizationResourcePath: URI
"""
The HTTP URL for the organization
"""
organizationUrl: URI
"""
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
}
"""
Represents a 'mentioned' event on a given issue or pull request.
"""
type MentionedEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the primary key from the database.
"""
databaseId: Int
id: ID!
}
"""
Autogenerated input type of MergeBranch
"""
input MergeBranchInput {
"""
The email address to associate with this commit.
"""
authorEmail: String
"""
The name of the base branch that the provided head will be merged into.
"""
base: String!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Message to use for the merge commit. If omitted, a default will be used.
"""
commitMessage: String
"""
The head to merge into the base branch. This can be a branch name or a commit GitObjectID.
"""
head: String!
"""
The Node ID of the Repository containing the base branch that will be modified.
"""
repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
Autogenerated return type of MergeBranch
"""
type MergeBranchPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The resulting merge Commit.
"""
mergeCommit: Commit
}
"""
Autogenerated input type of MergePullRequest
"""
input MergePullRequestInput {
"""
The email address to associate with this merge.
"""
authorEmail: String
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
Commit body to use for the merge commit; if omitted, a default message will be used
"""
commitBody: String
"""
Commit headline to use for the merge commit; if omitted, a default message will be used.
"""
commitHeadline: String
"""
OID that the pull request head ref must match to allow merge; if omitted, no check is performed.
"""
expectedHeadOid: GitObjectID
"""
The merge method to use. If omitted, defaults to 'MERGE'
"""
mergeMethod: PullRequestMergeMethod = MERGE
"""
ID of the pull request to be merged.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
Autogenerated return type of MergePullRequest
"""
type MergePullRequestPayload {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The pull request that was merged.
"""
pullRequest: PullRequest
}
"""
Detailed status information about a pull request merge.
"""
enum MergeStateStatus {
"""
The head ref is out of date.
"""
BEHIND
"""
The merge is blocked.
"""
BLOCKED
"""
Mergeable and passing commit status.
"""
CLEAN
"""
The merge commit cannot be cleanly created.
"""
DIRTY
"""
The merge is blocked due to the pull request being a draft.
"""
DRAFT
@deprecated(
reason: "DRAFT state will be removed from this enum and `isDraft` should be used instead Use PullRequest.isDraft instead. Removal on 2021-01-01 UTC."
)
"""
Mergeable with passing commit status and pre-receive hooks.
"""
HAS_HOOKS
"""
The state cannot currently be determined.
"""
UNKNOWN
"""
Mergeable with non-passing commit status.
"""
UNSTABLE
}
"""
Whether or not a PullRequest can be merged.
"""
enum MergeableState {
"""
The pull request cannot be merged due to merge conflicts.
"""
CONFLICTING
"""
The pull request can be merged.
"""
MERGEABLE
"""
The mergeability of the pull request is still being calculated.
"""
UNKNOWN
}
"""
Represents a 'merged' event on a given pull request.
"""
type MergedEvent implements Node & UniformResourceLocatable {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the commit associated with the `merge` event.
"""
commit: Commit
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
Identifies the Ref associated with the `merge` event.
"""
mergeRef: Ref
"""
Identifies the name of the Ref associated with the `merge` event.
"""
mergeRefName: String!
"""
PullRequest referenced by event.
"""
pullRequest: PullRequest!
"""
The HTTP path for this merged event.
"""
resourcePath: URI!
"""
The HTTP URL for this merged event.
"""
url: URI!
}
"""
Represents a Milestone object on a given repository.
"""
type Milestone implements Closable & Node & UniformResourceLocatable {
"""
`true` if the object is closed (definition of closed may depend on type)
"""
closed: Boolean!
"""
Identifies the date and time when the object was closed.
"""
closedAt: DateTime
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the actor who created the milestone.
"""
creator: Actor
"""
Identifies the description of the milestone.
"""
description: String
"""
Identifies the due date of the milestone.
"""
dueOn: DateTime
id: ID!
"""
A list of issues associated with the milestone.
"""
issues(
"""
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
"""
Filtering options for issues returned from the connection.
"""
filterBy: IssueFilters
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
A list of label names to filter the pull requests by.
"""
labels: [String!]
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for issues returned from the connection.
"""
orderBy: IssueOrder
"""
A list of states to filter the issues by.
"""
states: [IssueState!]
): IssueConnection!
"""
Identifies the number of the milestone.
"""
number: Int!
"""
Identifies the percentage complete for the milestone
"""
progressPercentage: Float!
"""
A list of pull requests associated with the milestone.
"""
pullRequests(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
The base ref name to filter the pull requests by.
"""
baseRefName: 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
"""
The head ref name to filter the pull requests by.
"""
headRefName: String
"""
A list of label names to filter the pull requests by.
"""
labels: [String!]
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for pull requests returned from the connection.
"""
orderBy: IssueOrder
"""
A list of states to filter the pull requests by.
"""
states: [PullRequestState!]
): PullRequestConnection!
"""
The repository associated with this milestone.
"""
repository: Repository!
"""
The HTTP path for this milestone
"""
resourcePath: URI!
"""
Identifies the state of the milestone.
"""
state: MilestoneState!
"""
Identifies the title of the milestone.
"""
title: String!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The HTTP URL for this milestone
"""
url: URI!
}
"""
The connection type for Milestone.
"""
type MilestoneConnection {
"""
A list of edges.
"""
edges: [MilestoneEdge]
"""
A list of nodes.
"""
nodes: [Milestone]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type MilestoneEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Milestone
}
"""
Types that can be inside a Milestone.
"""
union MilestoneItem = Issue | PullRequest
"""
Ordering options for milestone connections.
"""
input MilestoneOrder {
"""
The ordering direction.
"""
direction: OrderDirection!
"""
The field to order milestones by.
"""
field: MilestoneOrderField!
}
"""
Properties by which milestone connections can be ordered.
"""
enum MilestoneOrderField {
"""
Order milestones by when they were created.
"""
CREATED_AT
"""
Order milestones by when they are due.
"""
DUE_DATE
"""
Order milestones by their number.
"""
NUMBER
"""
Order milestones by when they were last updated.
"""
UPDATED_AT
}
"""
The possible states of a milestone.
"""
enum MilestoneState {
"""
A milestone that has been closed.
"""
CLOSED
"""
A milestone that is still open.
"""
OPEN
}
"""
Represents a 'milestoned' event on a given issue or pull request.
"""
type MilestonedEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
id: ID!
"""
Identifies the milestone title associated with the 'milestoned' event.
"""
milestoneTitle: String!
"""
Object referenced by event.
"""
subject: MilestoneItem!
}
"""
Entities that can be minimized.
"""
interface Minimizable {
"""
Returns whether or not a comment has been minimized.
"""
isMinimized: Boolean!
"""
Returns why the comment was minimized.
"""
minimizedReason: String
"""
Check if the current viewer can minimize this object.
"""
viewerCanMinimize: Boolean!
}
"""
Autogenerated input type of MinimizeComment
"""
input MinimizeCommentInput {
"""
The classification of comment
"""
classifier: ReportedContentClassifiers!
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The Node ID of the subject to modify.
"""
subjectId: ID!
@possibleTypes(
concreteTypes: ["CommitComment", "DiscussionComment", "GistComment", "IssueComment", "PullRequestReviewComment"]
abstractType: "Minimizable"
)
}
"""
Autogenerated return type of MinimizeComment
"""
type MinimizeCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The comment that was minimized.
"""
minimizedComment: Minimizable
}
"""
Autogenerated input type of MoveProjectCard
"""
input MoveProjectCardInput {
"""
Place the new card after the card with this id. Pass null to place it at the top.
"""
afterCardId: ID @possibleTypes(concreteTypes: ["ProjectCard"])
"""
The id of the card to move.
"""
cardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the column to move it into.
"""
columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
}
"""
Autogenerated return type of MoveProjectCard
"""
type MoveProjectCardPayload {
"""
The new edge of the moved card.
"""
cardEdge: ProjectCardEdge
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
}
"""
Autogenerated input type of MoveProjectColumn
"""
input MoveProjectColumnInput {
"""
Place the new column after the column with this id. Pass null to place it at the front.
"""
afterColumnId: ID @possibleTypes(concreteTypes: ["ProjectColumn"])
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The id of the column to move.
"""
columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
}
"""
Autogenerated return type of MoveProjectColumn
"""
type MoveProjectColumnPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new edge of the moved column.
"""
columnEdge: ProjectColumnEdge
}
"""
Represents a 'moved_columns_in_project' event on a given issue or pull request.
"""
type MovedColumnsInProjectEvent implements Node {
"""
Identifies the actor who performed the event.
"""
actor: Actor
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the primary key from the database.
"""
databaseId: Int
id: ID!
"""
Column name the issue or pull request was moved from.
"""
previousProjectColumnName: String! @preview(toggledBy: "starfox-preview")
"""
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 the issue or pull request was moved to.
"""
projectColumnName: String! @preview(toggledBy: "starfox-preview")
}
"""
The root query for implementing GraphQL mutations.
"""
type Mutation {
"""
Accepts a pending invitation for a user to become an administrator of an enterprise.
"""
acceptEnterpriseAdministratorInvitation(
"""
Parameters for AcceptEnterpriseAdministratorInvitation
"""
input: AcceptEnterpriseAdministratorInvitationInput!
): AcceptEnterpriseAdministratorInvitationPayload
"""
Applies a suggested topic to the repository.
"""
acceptTopicSuggestion(
"""
Parameters for AcceptTopicSuggestion
"""
input: AcceptTopicSuggestionInput!
): AcceptTopicSuggestionPayload
"""
Adds assignees to an assignable object.
"""
addAssigneesToAssignable(
"""
Parameters for AddAssigneesToAssignable
"""
input: AddAssigneesToAssignableInput!
): AddAssigneesToAssignablePayload
"""
Adds a comment to an Issue or Pull Request.
"""
addComment(
"""
Parameters for AddComment
"""
input: AddCommentInput!
): AddCommentPayload
"""
Adds a comment to a Discussion, possibly as a reply to another comment.
"""
addDiscussionComment(
"""
Parameters for AddDiscussionComment
"""
input: AddDiscussionCommentInput!
): AddDiscussionCommentPayload
"""
Adds a support entitlement to an enterprise member.
"""
addEnterpriseSupportEntitlement(
"""
Parameters for AddEnterpriseSupportEntitlement
"""
input: AddEnterpriseSupportEntitlementInput!
): AddEnterpriseSupportEntitlementPayload
"""
Adds labels to a labelable object.
"""
addLabelsToLabelable(
"""
Parameters for AddLabelsToLabelable
"""
input: AddLabelsToLabelableInput!
): AddLabelsToLabelablePayload
"""
Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both.
"""
addProjectCard(
"""
Parameters for AddProjectCard
"""
input: AddProjectCardInput!
): AddProjectCardPayload
"""
Adds a column to a Project.
"""
addProjectColumn(
"""
Parameters for AddProjectColumn
"""
input: AddProjectColumnInput!
): AddProjectColumnPayload
"""
Adds an existing item (Issue or PullRequest) to a Project.
"""
addProjectNextItem(
"""
Parameters for AddProjectNextItem
"""
input: AddProjectNextItemInput!
): AddProjectNextItemPayload
"""
Adds a review to a Pull Request.
"""
addPullRequestReview(
"""
Parameters for AddPullRequestReview
"""
input: AddPullRequestReviewInput!
): AddPullRequestReviewPayload
"""
Adds a comment to a review.
"""
addPullRequestReviewComment(
"""
Parameters for AddPullRequestReviewComment
"""
input: AddPullRequestReviewCommentInput!
): AddPullRequestReviewCommentPayload
"""
Adds a new thread to a pending Pull Request Review.
"""
addPullRequestReviewThread(
"""
Parameters for AddPullRequestReviewThread
"""
input: AddPullRequestReviewThreadInput!
): AddPullRequestReviewThreadPayload
"""
Adds a reaction to a subject.
"""
addReaction(
"""
Parameters for AddReaction
"""
input: AddReactionInput!
): AddReactionPayload
"""
Adds a star to a Starrable.
"""
addStar(
"""
Parameters for AddStar
"""
input: AddStarInput!
): AddStarPayload
"""
Add an upvote to a discussion or discussion comment.
"""
addUpvote(
"""
Parameters for AddUpvote
"""
input: AddUpvoteInput!
): AddUpvotePayload
"""
Adds a verifiable domain to an owning account.
"""
addVerifiableDomain(
"""
Parameters for AddVerifiableDomain
"""
input: AddVerifiableDomainInput!
): AddVerifiableDomainPayload
"""
Approve all pending deployments under one or more environments
"""
approveDeployments(
"""
Parameters for ApproveDeployments
"""
input: ApproveDeploymentsInput!
): ApproveDeploymentsPayload
"""
Approve a verifiable domain for notification delivery.
"""
approveVerifiableDomain(
"""
Parameters for ApproveVerifiableDomain
"""
input: ApproveVerifiableDomainInput!
): ApproveVerifiableDomainPayload
"""
Marks a repository as archived.
"""
archiveRepository(
"""
Parameters for ArchiveRepository
"""
input: ArchiveRepositoryInput!
): ArchiveRepositoryPayload
"""
Cancels a pending invitation for an administrator to join an enterprise.
"""
cancelEnterpriseAdminInvitation(
"""
Parameters for CancelEnterpriseAdminInvitation
"""
input: CancelEnterpriseAdminInvitationInput!
): CancelEnterpriseAdminInvitationPayload
"""
Cancel an active sponsorship.
"""
cancelSponsorship(
"""
Parameters for CancelSponsorship
"""
input: CancelSponsorshipInput!
): CancelSponsorshipPayload
"""
Update your status on GitHub.
"""
changeUserStatus(
"""
Parameters for ChangeUserStatus
"""
input: ChangeUserStatusInput!
): ChangeUserStatusPayload
"""
Clears all labels from a labelable object.
"""
clearLabelsFromLabelable(
"""
Parameters for ClearLabelsFromLabelable
"""
input: ClearLabelsFromLabelableInput!
): ClearLabelsFromLabelablePayload
"""
Creates a new project by cloning configuration from an existing project.
"""
cloneProject(
"""
Parameters for CloneProject
"""
input: CloneProjectInput!
): CloneProjectPayload
"""
Create a new repository with the same files and directory structure as a template repository.
"""
cloneTemplateRepository(
"""
Parameters for CloneTemplateRepository
"""
input: CloneTemplateRepositoryInput!
): CloneTemplateRepositoryPayload
"""
Close an issue.
"""
closeIssue(
"""
Parameters for CloseIssue
"""
input: CloseIssueInput!
): CloseIssuePayload
"""
Close a pull request.
"""
closePullRequest(
"""
Parameters for ClosePullRequest
"""
input: ClosePullRequestInput!
): ClosePullRequestPayload
"""
Convert a project note card to one associated with a newly created issue.
"""
convertProjectCardNoteToIssue(
"""
Parameters for ConvertProjectCardNoteToIssue
"""
input: ConvertProjectCardNoteToIssueInput!
): ConvertProjectCardNoteToIssuePayload
"""
Converts a pull request to draft
"""
convertPullRequestToDraft(
"""
Parameters for ConvertPullRequestToDraft
"""
input: ConvertPullRequestToDraftInput!
): ConvertPullRequestToDraftPayload
"""
Create a new branch protection rule
"""
createBranchProtectionRule(
"""
Parameters for CreateBranchProtectionRule
"""
input: CreateBranchProtectionRuleInput!
): CreateBranchProtectionRulePayload
"""
Create a check run.
"""
createCheckRun(
"""
Parameters for CreateCheckRun
"""
input: CreateCheckRunInput!
): CreateCheckRunPayload
"""
Create a check suite
"""
createCheckSuite(
"""
Parameters for CreateCheckSuite
"""
input: CreateCheckSuiteInput!
): CreateCheckSuitePayload
"""
Appends a commit to the given branch as the authenticated user.
This mutation creates a commit whose parent is the HEAD of the provided
branch and also updates that branch to point to the new commit.
It can be thought of as similar to `git commit`.
### Locating a Branch
Commits are appended to a `branch` of type `Ref`.
This must refer to a git branch (i.e. the fully qualified path must
begin with `refs/heads/`, although including this prefix is optional.
Callers may specify the `branch` to commit to either by its global node
ID or by passing both of `repositoryNameWithOwner` and `refName`. For
more details see the documentation for `CommittableBranch`.
### Describing Changes
`fileChanges` are specified as a `FilesChanges` object describing
`FileAdditions` and `FileDeletions`.
Please see the documentation for `FileChanges` for more information on
how to use this argument to describe any set of file changes.
### Authorship
Similar to the web commit interface, this mutation does not support
specifying the author or committer of the commit and will not add
support for this in the future.
A commit created by a successful execution of this mutation will be
authored by the owner of the credential which authenticates the API
request. The committer will be identical to that of commits authored
using the web interface.
If you need full control over author and committer information, please
use the Git Database REST API instead.
### Commit Signing
Commits made using this mutation are automatically signed by GitHub if
supported and will be marked as verified in the user interface.
"""
createCommitOnBranch(
"""
Parameters for CreateCommitOnBranch
"""
input: CreateCommitOnBranchInput!
): CreateCommitOnBranchPayload
"""
Creates a new deployment event.
"""
createDeployment(
"""
Parameters for CreateDeployment
"""
input: CreateDeploymentInput!
): CreateDeploymentPayload @preview(toggledBy: "flash-preview")
"""
Create a deployment status.
"""
createDeploymentStatus(
"""
Parameters for CreateDeploymentStatus
"""
input: CreateDeploymentStatusInput!
): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview")
"""
Create a discussion.
"""
createDiscussion(
"""
Parameters for CreateDiscussion
"""
input: CreateDiscussionInput!
): CreateDiscussionPayload
"""
Creates an organization as part of an enterprise account.
"""
createEnterpriseOrganization(
"""
Parameters for CreateEnterpriseOrganization
"""
input: CreateEnterpriseOrganizationInput!
): CreateEnterpriseOrganizationPayload
"""
Creates an environment or simply returns it if already exists.
"""
createEnvironment(
"""
Parameters for CreateEnvironment
"""
input: CreateEnvironmentInput!
): CreateEnvironmentPayload
"""
Creates a new IP allow list entry.
"""
createIpAllowListEntry(
"""
Parameters for CreateIpAllowListEntry
"""
input: CreateIpAllowListEntryInput!
): CreateIpAllowListEntryPayload
"""
Creates a new issue.
"""