GraphQL API Schema Changes

The GraphQL schema change log is a list of recent and upcoming changes to our GraphQL API schema. It includes backwards-compatible changes, schema previews, and upcoming breaking changes.

Breaking changes include changes that will break existing queries or could affect the runtime behavior of clients. For a list of breaking changes and when they will occur, see our breaking changes log.

GraphQL Schema Changes for 2018-08-09

August 9, 2018
hubot

The Temporary Cloning Token for Private Repositories preview includes these changes:

Field tempCloneToken was added to object type Repository

GraphQL Schema Changes for 2018-08-07

August 7, 2018
hubot

The GraphQL schema includes these changes:

Field isVerified was added to object type Organization
Field app was added to object type MarketplaceListing
Type App was added

The Checks preview includes these changes:

Field warningLevel was removed from object type CheckAnnotation
Field startLine was removed from object type CheckAnnotation
Field filename was removed from object type CheckAnnotation
Field endLine was removed from object type CheckAnnotation
Field creator was removed from object type CheckRun
Field updateCheckSuitePreferences was added to object type Mutation
Field updateCheckRun was added to object type Mutation
Field rerequestCheckSuite was added to object type Mutation
Field createCheckSuite was added to object type Mutation
Field createCheckRun was added to object type Mutation
Field path was added to object type CheckAnnotation
Field location was added to object type CheckAnnotation
Field annotationLevel was added to object type CheckAnnotation
Type CheckSuiteAutoTriggerPreference was added
Type UpdateCheckSuitePreferencesInput was added
Type UpdateCheckSuitePreferencesPayload was added
Type UpdateCheckRunInput was added
Type UpdateCheckRunPayload was added
Type RerequestCheckSuiteInput was added
Type RerequestCheckSuitePayload was added
Type CreateCheckSuiteInput was added
Type CreateCheckSuitePayload was added
Type RequestableCheckStatusState was added
Type CheckRunOutputImage was added
Type CheckAnnotationRange was added
Type CheckAnnotationData was added
Type CheckRunOutput was added
Type CheckRunAction was added
Type CreateCheckRunInput was added
Type CreateCheckRunPayload was added
Type CheckAnnotationPosition was added
Type CheckAnnotationSpan was added

GraphQL Schema Changes for 2018-08-01

August 1, 2018
hubot

The following changes will be made to the schema:

On member AcceptTopicSuggestionPayload.topic: Type for topic will change from Topic! to Topic. Effective 2019-01-01.
On member AddCommentPayload.commentEdge: Type for commentEdge will change from IssueCommentEdge! to IssueCommentEdge. Effective 2019-01-01.
On member AddCommentPayload.subject: Type for subject will change from Node! to Node. Effective 2019-01-01.
On member AddCommentPayload.timelineEdge: Type for timelineEdge will change from IssueTimelineItemEdge! to IssueTimelineItemEdge. Effective 2019-01-01.
On member AddProjectCardPayload.cardEdge: Type for cardEdge will change from ProjectCardEdge! to ProjectCardEdge. Effective 2019-01-01.
On member AddProjectCardPayload.projectColumn: Type for projectColumn will change from Project! to Project. Effective 2019-01-01.
On member AddProjectColumnPayload.columnEdge: Type for columnEdge will change from ProjectColumnEdge! to ProjectColumnEdge. Effective 2019-01-01.
On member AddProjectColumnPayload.project: Type for project will change from Project! to Project. Effective 2019-01-01.
On member AddPullRequestReviewCommentPayload.comment: Type for comment will change from PullRequestReviewComment! to PullRequestReviewComment. Effective 2019-01-01.
On member AddPullRequestReviewCommentPayload.commentEdge: Type for commentEdge will change from PullRequestReviewCommentEdge! to PullRequestReviewCommentEdge. Effective 2019-01-01.
On member AddPullRequestReviewPayload.pullRequestReview: Type for pullRequestReview will change from PullRequestReview! to PullRequestReview. Effective 2019-01-01.
On member AddPullRequestReviewPayload.reviewEdge: Type for reviewEdge will change from PullRequestReviewEdge! to PullRequestReviewEdge. Effective 2019-01-01.
On member AddReactionPayload.reaction: Type for reaction will change from Reaction! to Reaction. Effective 2019-01-01.
On member AddReactionPayload.subject: Type for subject will change from Reactable! to Reactable. Effective 2019-01-01.
On member AddStarPayload.starrable: Type for starrable will change from Starrable! to Starrable. Effective 2019-01-01.
On member CreateProjectPayload.project: Type for project will change from Project! to Project. Effective 2019-01-01.
On member DeclineTopicSuggestionPayload.topic: Type for topic will change from Topic! to Topic. Effective 2019-01-01.
On member DeleteProjectCardPayload.column: Type for column will change from ProjectColumn! to ProjectColumn. Effective 2019-01-01.
On member DeleteProjectCardPayload.deletedCardId: Type for deletedCardId will change from ID! to ID. Effective 2019-01-01.
On member DeleteProjectColumnPayload.deletedColumnId: Type for deletedColumnId will change from ID! to ID. Effective 2019-01-01.
On member DeleteProjectColumnPayload.project: Type for project will change from Project! to Project. Effective 2019-01-01.
On member DeleteProjectPayload.owner: Type for owner will change from ProjectOwner! to ProjectOwner. Effective 2019-01-01.
On member DeletePullRequestReviewPayload.pullRequestReview: Type for pullRequestReview will change from PullRequestReview! to PullRequestReview. Effective 2019-01-01.
On member DismissPullRequestReviewPayload.pullRequestReview: Type for pullRequestReview will change from PullRequestReview! to PullRequestReview. Effective 2019-01-01.
On member MoveProjectCardPayload.cardEdge: Type for cardEdge will change from ProjectCardEdge! to ProjectCardEdge. Effective 2019-01-01.
On member MoveProjectColumnPayload.columnEdge: Type for columnEdge will change from ProjectColumnEdge! to ProjectColumnEdge. Effective 2019-01-01.
On member RemoveOutsideCollaboratorPayload.removedUser: Type for removedUser will change from User! to User. Effective 2019-01-01.
On member RemoveReactionPayload.reaction: Type for reaction will change from Reaction! to Reaction. Effective 2019-01-01.
On member RemoveReactionPayload.subject: Type for subject will change from Reactable! to Reactable. Effective 2019-01-01.
On member RemoveStarPayload.starrable: Type for starrable will change from Starrable! to Starrable. Effective 2019-01-01.
On member RequestReviewsPayload.pullRequest: Type for pullRequest will change from PullRequest! to PullRequest. Effective 2019-01-01.
On member RequestReviewsPayload.requestedReviewersEdge: Type for requestedReviewersEdge will change from UserEdge! to UserEdge. Effective 2019-01-01.
On member SubmitPullRequestReviewPayload.pullRequestReview: Type for pullRequestReview will change from PullRequestReview! to PullRequestReview. Effective 2019-01-01.
On member UpdateProjectCardPayload.projectCard: Type for projectCard will change from ProjectCard! to ProjectCard. Effective 2019-01-01.
On member UpdateProjectColumnPayload.projectColumn: Type for projectColumn will change from ProjectColumn! to ProjectColumn. Effective 2019-01-01.
On member UpdateProjectPayload.project: Type for project will change from Project! to Project. Effective 2019-01-01.
On member UpdatePullRequestReviewCommentPayload.pullRequestReviewComment: Type for pullRequestReviewComment will change from PullRequestReviewComment! to PullRequestReviewComment. Effective 2019-01-01.
On member UpdatePullRequestReviewPayload.pullRequestReview: Type for pullRequestReview will change from PullRequestReview! to PullRequestReview. Effective 2019-01-01.
On member UpdateSubscriptionPayload.subscribable: Type for subscribable will change from Subscribable! to Subscribable. Effective 2019-01-01.
On member UpdateTopicsPayload.repository: Type for repository will change from Repository! to Repository. Effective 2019-01-01.

GraphQL Schema Changes for 2018-07-26

July 26, 2018
hubot

The Deployments preview includes these changes:

Enum value QUEUED was added to enum DeploymentState
Enum value IN_PROGRESS was added to enum DeploymentState
Field createDeploymentStatus was added to object type Mutation
Field createDeployment was added to object type Mutation
Field environment was added to object type DeploymentStatus
Type CreateDeploymentStatusInput was added
Type CreateDeploymentStatusPayload was added
Type CreateDeploymentInput was added
Type CreateDeploymentPayload was added

GraphQL Schema Changes for 2018-07-16

July 16, 2018
hubot

The GraphQL schema includes these changes:

Field task was added to object type Deployment

GraphQL Schema Changes for 2018-07-13

July 13, 2018
hubot

The GraphQL schema includes these changes:

Field GitHubMetadata.gitHubServicesSha changed type from String! to GitObjectID!
Type RepositoryInvitationEdge was removed
Type RepositoryCollaboratorAffiliation was removed
Type PullRequestPubSubTopic was removed
Type IssuePubSubTopic was removed
Type DefaultRepositoryPermissionField was removed
Type Date was removed