# Authoritative GitHub.com GraphQL read/write contract subset.
# The full schema is intentionally reduced to the types and fields selected by this plugin;
# tests validate every production document against this artifact.
#
# `ProjectV2.shortDescription` and `ProjectV2.readme` are absent on purpose, and so is
# `updateProjectV2`: a board is a container of projects here, never a project, and nothing
# this source does writes the board's own fields. `updateProjectV2Field` is present only
# for the guarded status-options document, whose caller sends all existing option ids and
# verifies every id and item assignment after GitHub replaces the complete option set.
#
# `createProjectV2Field` (with `CreateProjectV2FieldInput`, `ProjectV2CustomFieldType` and
# `CreateProjectV2FieldPayload`) and `clearProjectV2ItemFieldValue` (with
# `ClearProjectV2ItemFieldValueInput` and `ClearProjectV2ItemFieldValuePayload`) were copied from
# GitHub's published GraphQL schema reference (docs.github.com/en/graphql/reference/mutations,
# /input-objects, /enums and /objects), retrieved 2026-09-26, reduced to the members this plugin
# sends and selects. The first is sent only by the guarded field setup, for a `Priority` field a
# board lacks; the second clears one item's `Priority` value, which is what a `none` priority is.
schema {
query: Query
mutation: Mutation
}
scalar String
scalar ID
scalar Int
scalar Boolean
type Query {
repositoryOwner(login: String!): RepositoryOwner
repository(owner: String!, name: String!, followRenames: Boolean = true): Repository
node(id: ID!): Node
search(query: String!, type: SearchType!, first: Int, after: String): SearchResultItemConnection!
}
enum SearchType {
ISSUE
REPOSITORY
USER
DISCUSSION
}
type SearchResultItemConnection {
issueCount: Int!
nodes: [SearchResultItem]
pageInfo: PageInfo!
}
union SearchResultItem = Issue | PullRequest
type Mutation {
createIssue(input: CreateIssueInput!): CreateIssuePayload
addProjectV2ItemById(input: AddProjectV2ItemByIdInput!): AddProjectV2ItemByIdPayload
updateIssue(input: UpdateIssueInput!): UpdateIssuePayload
updateProjectV2DraftIssue(
input: UpdateProjectV2DraftIssueInput!
): UpdateProjectV2DraftIssuePayload
updateProjectV2ItemFieldValue(
input: UpdateProjectV2ItemFieldValueInput!
): UpdateProjectV2ItemFieldValuePayload
updateProjectV2Field(input: UpdateProjectV2FieldInput!): UpdateProjectV2FieldPayload
createProjectV2Field(input: CreateProjectV2FieldInput!): CreateProjectV2FieldPayload
clearProjectV2ItemFieldValue(
input: ClearProjectV2ItemFieldValueInput!
): ClearProjectV2ItemFieldValuePayload
addSubIssue(input: AddSubIssueInput!): AddSubIssuePayload
removeSubIssue(input: RemoveSubIssueInput!): RemoveSubIssuePayload
addBlockedBy(input: AddBlockedByInput!): AddBlockedByPayload
removeBlockedBy(input: RemoveBlockedByInput!): RemoveBlockedByPayload
deleteIssue(input: DeleteIssueInput!): DeleteIssuePayload
addComment(input: AddCommentInput!): AddCommentPayload
updateIssueComment(input: UpdateIssueCommentInput!): UpdateIssueCommentPayload
deleteIssueComment(input: DeleteIssueCommentInput!): DeleteIssueCommentPayload
}
input DeleteIssueInput {
issueId: ID!
}
input AddCommentInput {
subjectId: ID!
body: String!
clientMutationId: String
}
input UpdateIssueCommentInput {
id: ID!
body: String!
clientMutationId: String
}
input DeleteIssueCommentInput {
id: ID!
clientMutationId: String
}
type AddCommentPayload {
clientMutationId: String
commentEdge: IssueCommentEdge
subject: Node
}
type UpdateIssueCommentPayload {
clientMutationId: String
issueComment: IssueComment
}
type DeleteIssueCommentPayload {
clientMutationId: String
}
input CreateIssueInput {
repositoryId: ID!
title: String!
body: String
labelIds: [ID!]
parentIssueId: ID
}
input AddProjectV2ItemByIdInput {
projectId: ID!
contentId: ID!
}
input UpdateIssueInput {
id: ID!
title: String
body: String
state: IssueState
stateInput: IssueStateUpdateInput
}
input IssueStateUpdateInput {
value: IssueState!
stateReason: IssueClosedStateReason
duplicateIssueId: ID
}
input UpdateProjectV2DraftIssueInput {
draftIssueId: ID!
title: String
body: String
}
input UpdateProjectV2ItemFieldValueInput {
projectId: ID!
itemId: ID!
fieldId: ID!
value: ProjectV2FieldValue!
}
input ProjectV2FieldValue {
text: String
singleSelectOptionId: String
}
input UpdateProjectV2FieldInput {
projectId: ID!
fieldId: ID!
singleSelectOptions: [ProjectV2SingleSelectFieldOptionInput!]
}
input CreateProjectV2FieldInput {
projectId: ID!
dataType: ProjectV2CustomFieldType!
name: String!
singleSelectOptions: [ProjectV2SingleSelectFieldOptionInput!]
}
enum ProjectV2CustomFieldType {
DATE
ITERATION
NUMBER
SINGLE_SELECT
TEXT
}
input ClearProjectV2ItemFieldValueInput {
projectId: ID!
itemId: ID!
fieldId: ID!
}
input ProjectV2SingleSelectFieldOptionInput {
id: ID
name: String!
color: ProjectV2SingleSelectFieldOptionColor!
description: String!
}
enum ProjectV2SingleSelectFieldOptionColor {
GRAY
BLUE
GREEN
YELLOW
PURPLE
RED
ORANGE
PINK
}
input AddSubIssueInput {
issueId: ID!
subIssueId: ID
replaceParent: Boolean
}
input RemoveSubIssueInput {
issueId: ID!
subIssueId: ID!
}
input AddBlockedByInput {
issueId: ID!
blockingIssueId: ID!
}
input RemoveBlockedByInput {
issueId: ID!
blockingIssueId: ID!
}
type CreateIssuePayload {
issue: Issue
}
type AddProjectV2ItemByIdPayload {
item: ProjectV2Item
}
type UpdateIssuePayload {
issue: Issue
}
type UpdateProjectV2DraftIssuePayload {
draftIssue: DraftIssue
}
type UpdateProjectV2ItemFieldValuePayload {
projectV2Item: ProjectV2Item
}
type UpdateProjectV2FieldPayload {
projectV2Field: ProjectV2FieldConfiguration
}
type CreateProjectV2FieldPayload {
projectV2Field: ProjectV2FieldConfiguration
}
type ClearProjectV2ItemFieldValuePayload {
projectV2Item: ProjectV2Item
}
type AddSubIssuePayload {
issue: Issue
subIssue: Issue
}
type RemoveSubIssuePayload {
issue: Issue
subIssue: Issue
}
type AddBlockedByPayload {
issue: Issue
blockingIssue: Issue
}
type RemoveBlockedByPayload {
issue: Issue
blockingIssue: Issue
}
type DeleteIssuePayload {
repository: Repository
}
interface Node {
id: ID!
}
interface RepositoryOwner {
id: ID!
}
interface ProjectV2Owner {
projectV2(number: Int!): ProjectV2
}
type Organization implements Node & RepositoryOwner & ProjectV2Owner {
id: ID!
projectV2(number: Int!): ProjectV2
}
type User implements Node & RepositoryOwner & ProjectV2Owner {
id: ID!
projectV2(number: Int!): ProjectV2
}
type ProjectV2 implements Node {
id: ID!
number: Int!
title: String!
createdAt: DateTime!
updatedAt: DateTime!
fields(first: Int, after: String): ProjectV2FieldConfigurationConnection!
items(first: Int, after: String): ProjectV2ItemConnection!
}
type ProjectV2FieldConfigurationConnection {
nodes: [ProjectV2FieldConfiguration]
pageInfo: PageInfo!
}
type ProjectV2Item implements Node {
id: ID!
project: ProjectV2!
fieldValues(first: Int, after: String): ProjectV2ItemFieldValueConnection!
content: ProjectV2ItemContent
}
union ProjectV2ItemContent = DraftIssue | Issue | PullRequest | RedactedProjectV2Item
union ProjectV2ItemFieldValue =
| ProjectV2ItemFieldLabelValue
| ProjectV2ItemFieldSingleSelectValue
| ProjectV2ItemFieldTextValue
union ProjectV2FieldConfiguration = ProjectV2SingleSelectField | ProjectV2Field
type ProjectV2ItemFieldValueConnection {
nodes: [ProjectV2ItemFieldValue]
pageInfo: PageInfo!
}
type ProjectV2ItemFieldSingleSelectValue {
name: String
optionId: String
field: ProjectV2FieldConfiguration!
}
type ProjectV2ItemFieldLabelValue {
labels(first: Int, after: String): LabelConnection!
}
type ProjectV2ItemFieldTextValue {
text: String
field: ProjectV2FieldConfiguration!
}
type ProjectV2SingleSelectField {
id: ID!
name: String!
options: [ProjectV2SingleSelectFieldOption!]!
}
type ProjectV2Field {
id: ID!
name: String!
}
type ProjectV2SingleSelectFieldOption {
id: ID!
name: String!
color: ProjectV2SingleSelectFieldOptionColor!
description: String
}
type Issue implements Node {
id: ID!
number: Int!
title: String!
body: String!
url: URI!
createdAt: DateTime!
updatedAt: DateTime!
state: IssueState!
stateReason(enableDuplicate: Boolean = false): IssueStateReason
repository: Repository!
parent: Issue
subIssues(first: Int, after: String): IssueConnection!
subIssuesSummary: SubIssuesSummary!
projectItems(first: Int, after: String, includeArchived: Boolean = true): ProjectV2ItemConnection!
labels(first: Int, after: String): LabelConnection
blockedBy(first: Int, after: String): IssueConnection!
blocking(first: Int, after: String): IssueConnection!
comments(first: Int, after: String, orderBy: IssueCommentOrder): IssueCommentConnection!
}
interface Actor {
login: String!
}
type IssueComment implements Node {
id: ID!
author: Actor
body: String!
createdAt: DateTime!
updatedAt: DateTime!
url: URI!
issue: Issue!
}
type IssueCommentConnection {
nodes: [IssueComment]
pageInfo: PageInfo!
}
type IssueCommentEdge {
cursor: String!
node: IssueComment
}
input IssueCommentOrder {
direction: OrderDirection!
field: IssueCommentOrderField!
}
enum IssueCommentOrderField {
UPDATED_AT
}
enum OrderDirection {
ASC
DESC
}
type SubIssuesSummary {
total: Int!
completed: Int!
percentCompleted: Int!
}
type PullRequest implements Node {
id: ID!
title: String!
body: String!
url: URI!
createdAt: DateTime!
updatedAt: DateTime!
state: PullRequestState!
repository: Repository!
labels(first: Int, after: String): LabelConnection
}
type Repository implements Node {
id: ID!
nameWithOwner: String!
}
type DraftIssue implements Node {
id: ID!
title: String!
body: String
createdAt: DateTime!
updatedAt: DateTime!
projectV2Items(first: Int, after: String): ProjectV2ItemConnection!
}
type RedactedProjectV2Item implements Node {
id: ID!
}
type Label implements Node {
id: ID!
name: String!
color: String!
}
type ProjectV2ItemConnection {
nodes: [ProjectV2Item!]
pageInfo: PageInfo!
}
type IssueConnection {
nodes: [Issue]
pageInfo: PageInfo!
}
type LabelConnection {
nodes: [Label]
pageInfo: PageInfo!
}
type PageInfo {
hasNextPage: Boolean!
endCursor: String
}
enum IssueState {
OPEN
CLOSED
}
enum IssueStateReason {
COMPLETED
DUPLICATE
NOT_PLANNED
REOPENED
}
enum IssueClosedStateReason {
COMPLETED
DUPLICATE
NOT_PLANNED
}
enum PullRequestState {
OPEN
CLOSED
MERGED
}
scalar DateTime
scalar URI