我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 已停止服务 2021-03-02. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

输入对象

本文内容

关于输入对象

输入对象可描述为“可组合对象”,因为它们包含一组用于定义对象的输入字段。

例如,CommitAuthor 需要一个名为 emails 的字段。 为 emails 提供一个值可将 CommitAuthor 转变成包含电子邮件地址的 User 对象列表。 请注意,对象 may(可能)包含输入对象,然而,突变 require(需要)输入对象。

更多信息请参阅“关于突变。”

AddAssigneesToAssignableInput

Autogenerated input type of AddAssigneesToAssignable.

输入字段

名称 描述

assignableId (ID!)

The id of the assignable object to add assignees to.

assigneeIds ([ID!]!)

The id of users to add as assignees.

clientMutationId (String)

A unique identifier for the client performing the mutation.


AddCommentInput

Autogenerated input type of AddComment.

输入字段

名称 描述

body (String!)

The contents of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the subject to modify.


AddEnterpriseAdminInput

Autogenerated input type of AddEnterpriseAdmin.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise account to which the administrator should be added.

login (String!)

The login of the user to add as an administrator.


AddLabelsToLabelableInput

Autogenerated input type of AddLabelsToLabelable.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelIds ([ID!]!)

The ids of the labels to add.

labelableId (ID!)

The id of the labelable object to add labels to.


AddProjectCardInput

Autogenerated input type of AddProjectCard.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

note (String)

The note on the card.

projectColumnId (ID!)

The Node ID of the ProjectColumn.


AddProjectColumnInput

Autogenerated input type of AddProjectColumn.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of the column.

projectId (ID!)

The Node ID of the project.


AddPullRequestReviewCommentInput

Autogenerated input type of AddPullRequestReviewComment.

输入字段

名称 描述

body (String!)

The text of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitOID (GitObjectID)

The SHA of the commit to comment on.

inReplyTo (ID)

The comment id to reply to.

path (String)

The relative path of the file to comment on.

position (Int)

The line index in the diff to comment on.

pullRequestReviewId (ID!)

The Node ID of the review to modify.


AddPullRequestReviewInput

Autogenerated input type of AddPullRequestReview.

输入字段

名称 描述

body (String)

The contents of the review body comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

comments ([DraftPullRequestReviewComment])

The review line comments.

commitOID (GitObjectID)

The commit OID the review pertains to.

event (PullRequestReviewEvent)

The event to perform on the pull request review.

pullRequestId (ID!)

The Node ID of the pull request to modify.

threads ([DraftPullRequestReviewThread])

The review line comment threads.


AddPullRequestReviewThreadInput

Autogenerated input type of AddPullRequestReviewThread.

预览通知

AddPullRequestReviewThreadInput is available under the Multi line comments preview. During the preview period, the API may change without notice.

输入字段

名称 描述

body (String!)

Body of the thread's first comment.

预览通知

AddPullRequestReviewThreadInput is available under the Multi line comments preview. During the preview period, the API may change without notice.

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

AddPullRequestReviewThreadInput is available under the Multi line comments preview. During the preview period, the API may change without notice.

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

预览通知

AddPullRequestReviewThreadInput is available under the Multi line comments preview. During the preview period, the API may change without notice.

path (String!)

Path to the file being commented on.

预览通知

AddPullRequestReviewThreadInput is available under the Multi line comments preview. During the preview period, the API may change without notice.

pullRequestReviewId (ID!)

The Node ID of the review to modify.

预览通知

AddPullRequestReviewThreadInput is available under the Multi line comments preview. During the preview period, the API may change without notice.

side (DiffSide)

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.

预览通知

AddPullRequestReviewThreadInput is available under the Multi line comments preview. During the preview period, the API may change without notice.

startLine (Int)

The first line of the range to which the comment refers.

预览通知

AddPullRequestReviewThreadInput is available under the Multi line comments preview. During the preview period, the API may change without notice.

startSide (DiffSide)

The side of the diff on which the start line resides.

预览通知

AddPullRequestReviewThreadInput is available under the Multi line comments preview. During the preview period, the API may change without notice.


AddReactionInput

Autogenerated input type of AddReaction.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

content (ReactionContent!)

The name of the emoji to react with.

subjectId (ID!)

The Node ID of the subject to modify.


AddStarInput

Autogenerated input type of AddStar.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to star.


ArchiveRepositoryInput

Autogenerated input type of ArchiveRepository.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The ID of the repository to mark as archived.


AuditLogOrder

Ordering options for Audit Log connections.

输入字段

名称 描述

direction (OrderDirection)

The ordering direction.

field (AuditLogOrderField)

The field to order Audit Logs by.


ChangeUserStatusInput

Autogenerated input type of ChangeUserStatus.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

expiresAt (DateTime)

If set, the user status will not be shown after this date.

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

message (String)

A short description of your current status.

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If omitted, the status will be publicly visible.


CheckAnnotationData

Information from a check run analysis to specific lines of code.

预览通知

CheckAnnotationData is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

预览通知

CheckAnnotationData is available under the Checks preview. During the preview period, the API may change without notice.

location (CheckAnnotationRange!)

The location of the annotation.

预览通知

CheckAnnotationData is available under the Checks preview. During the preview period, the API may change without notice.

message (String!)

A short description of the feedback for these lines of code.

预览通知

CheckAnnotationData is available under the Checks preview. During the preview period, the API may change without notice.

path (String!)

The path of the file to add an annotation to.

预览通知

CheckAnnotationData is available under the Checks preview. During the preview period, the API may change without notice.

rawDetails (String)

Details about this annotation.

预览通知

CheckAnnotationData is available under the Checks preview. During the preview period, the API may change without notice.

title (String)

The title that represents the annotation.

预览通知

CheckAnnotationData is available under the Checks preview. During the preview period, the API may change without notice.


CheckAnnotationRange

Information from a check run analysis to specific lines of code.

预览通知

CheckAnnotationRange is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

endColumn (Int)

The ending column of the range.

预览通知

CheckAnnotationRange is available under the Checks preview. During the preview period, the API may change without notice.

endLine (Int!)

The ending line of the range.

预览通知

CheckAnnotationRange is available under the Checks preview. During the preview period, the API may change without notice.

startColumn (Int)

The starting column of the range.

预览通知

CheckAnnotationRange is available under the Checks preview. During the preview period, the API may change without notice.

startLine (Int!)

The starting line of the range.

预览通知

CheckAnnotationRange is available under the Checks preview. During the preview period, the API may change without notice.


CheckRunAction

Possible further actions the integrator can perform.

预览通知

CheckRunAction is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

description (String!)

A short explanation of what this action would do.

预览通知

CheckRunAction is available under the Checks preview. During the preview period, the API may change without notice.

identifier (String!)

A reference for the action on the integrator's system.

预览通知

CheckRunAction is available under the Checks preview. During the preview period, the API may change without notice.

label (String!)

The text to be displayed on a button in the web UI.

预览通知

CheckRunAction is available under the Checks preview. During the preview period, the API may change without notice.


CheckRunFilter

The filters that are available when fetching check runs.

预览通知

CheckRunFilter is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

appId (Int)

Filters the check runs created by this application ID.

预览通知

CheckRunFilter is available under the Checks preview. During the preview period, the API may change without notice.

checkName (String)

Filters the check runs by this name.

预览通知

CheckRunFilter is available under the Checks preview. During the preview period, the API may change without notice.

checkType (CheckRunType)

Filters the check runs by this type.

预览通知

CheckRunFilter is available under the Checks preview. During the preview period, the API may change without notice.

status (CheckStatusState)

Filters the check runs by this status.

预览通知

CheckRunFilter is available under the Checks preview. During the preview period, the API may change without notice.


CheckRunOutput

Descriptive details about the check run.

预览通知

CheckRunOutput is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

预览通知

CheckRunOutput is available under the Checks preview. During the preview period, the API may change without notice.

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

预览通知

CheckRunOutput is available under the Checks preview. During the preview period, the API may change without notice.

summary (String!)

The summary of the check run (supports Commonmark).

预览通知

CheckRunOutput is available under the Checks preview. During the preview period, the API may change without notice.

text (String)

The details of the check run (supports Commonmark).

预览通知

CheckRunOutput is available under the Checks preview. During the preview period, the API may change without notice.

title (String!)

A title to provide for this check run.

预览通知

CheckRunOutput is available under the Checks preview. During the preview period, the API may change without notice.


CheckRunOutputImage

Images attached to the check run output displayed in the GitHub pull request UI.

预览通知

CheckRunOutputImage is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

alt (String!)

The alternative text for the image.

预览通知

CheckRunOutputImage is available under the Checks preview. During the preview period, the API may change without notice.

caption (String)

A short image description.

预览通知

CheckRunOutputImage is available under the Checks preview. During the preview period, the API may change without notice.

imageUrl (URI!)

The full URL of the image.

预览通知

CheckRunOutputImage is available under the Checks preview. During the preview period, the API may change without notice.


CheckSuiteAutoTriggerPreference

The auto-trigger preferences that are available for check suites.

预览通知

CheckSuiteAutoTriggerPreference is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

appId (ID!)

The node ID of the application that owns the check suite.

预览通知

CheckSuiteAutoTriggerPreference is available under the Checks preview. During the preview period, the API may change without notice.

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

预览通知

CheckSuiteAutoTriggerPreference is available under the Checks preview. During the preview period, the API may change without notice.


CheckSuiteFilter

The filters that are available when fetching check suites.

预览通知

CheckSuiteFilter is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

appId (Int)

Filters the check suites created by this application ID.

预览通知

CheckSuiteFilter is available under the Checks preview. During the preview period, the API may change without notice.

checkName (String)

Filters the check suites by this name.

预览通知

CheckSuiteFilter is available under the Checks preview. During the preview period, the API may change without notice.


ClearLabelsFromLabelableInput

Autogenerated input type of ClearLabelsFromLabelable.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelableId (ID!)

The id of the labelable object to clear the labels from.


CloneProjectInput

Autogenerated input type of CloneProject.

输入字段

名称 描述

body (String)

The description of the project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

name (String!)

The name of the project.

public (Boolean)

The visibility of the project, defaults to false (private).

sourceId (ID!)

The source project to clone.

targetOwnerId (ID!)

The owner ID to create the project under.


CloneTemplateRepositoryInput

Autogenerated input type of CloneTemplateRepository.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A short description of the new repository.

name (String!)

The name of the new repository.

ownerId (ID!)

The ID of the owner for the new repository.

repositoryId (ID!)

The Node ID of the template repository.

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.


CloseIssueInput

Autogenerated input type of CloseIssue.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

ID of the issue to be closed.


ClosePullRequestInput

Autogenerated input type of ClosePullRequest.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to be closed.


CommitAuthor

Specifies an author for filtering Git commits.

输入字段

名称 描述

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

id (ID)

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.


CommitContributionOrder

Ordering options for commit contribution connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (CommitContributionOrderField!)

The field by which to order commit contributions.


ContributionOrder

Ordering options for contribution connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (ContributionOrderField)

The field by which to order contributions.

Upcoming Change on 2019-10-01 UTC Description: field will be removed. Only one order field is supported. Reason: field will be removed.


ConvertProjectCardNoteToIssueInput

Autogenerated input type of ConvertProjectCardNoteToIssue.

输入字段

名称 描述

body (String)

The body of the newly created issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCardId (ID!)

The ProjectCard ID to convert.

repositoryId (ID!)

The ID of the repository to create the issue in.

title (String)

The title of the newly created issue. Defaults to the card's note text.


CreateBranchProtectionRuleInput

Autogenerated input type of CreateBranchProtectionRule.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

pattern (String!)

The glob-like pattern used to determine matching branches.

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

requiresCommitSignatures (Boolean)

Are commits required to be signed.

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.


CreateCheckRunInput

Autogenerated input type of CreateCheckRun.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

completedAt (DateTime)

The time that the check run finished.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

conclusion (CheckConclusionState)

The final conclusion of the check.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

externalId (String)

A reference for the run on the integrator's system.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

headSha (GitObjectID!)

The SHA of the head commit.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

name (String!)

The name of the check.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

output (CheckRunOutput)

Descriptive details about the run.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

repositoryId (ID!)

The node ID of the repository.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

startedAt (DateTime)

The time that the check run began.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

status (RequestableCheckStatusState)

The current status.

预览通知

CreateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.


CreateCheckSuiteInput

Autogenerated input type of CreateCheckSuite.

预览通知

CreateCheckSuiteInput is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

CreateCheckSuiteInput is available under the Checks preview. During the preview period, the API may change without notice.

headSha (GitObjectID!)

The SHA of the head commit.

预览通知

CreateCheckSuiteInput is available under the Checks preview. During the preview period, the API may change without notice.

repositoryId (ID!)

The Node ID of the repository.

预览通知

CreateCheckSuiteInput is available under the Checks preview. During the preview period, the API may change without notice.


CreateContentAttachmentInput

Autogenerated input type of CreateContentAttachment.

输入字段

名称 描述

body (String!)

The body of the content attachment, which may contain markdown.

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentReferenceId (ID!)

The node ID of the content_reference.

title (String!)

The title of the content attachment.


CreateDeploymentInput

Autogenerated input type of CreateDeployment.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

输入字段

名称 描述

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

description (String)

Short description of the deployment.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

environment (String)

Name for the target deployment environment.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

payload (String)

JSON payload with extra information about the deployment.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

refId (ID!)

The node ID of the ref to be deployed.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

repositoryId (ID!)

The node ID of the repository.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required contexts, pass an empty array. Defaults to all unique contexts.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

task (String)

Specifies a task to execute.

预览通知

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.


CreateDeploymentStatusInput

Autogenerated input type of CreateDeploymentStatus.

预览通知

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

输入字段

名称 描述

autoInactive (Boolean)

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.

预览通知

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

deploymentId (ID!)

The node ID of the deployment.

预览通知

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

description (String)

A short description of the status. Maximum length of 140 characters.

预览通知

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

预览通知

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

environmentUrl (String)

Sets the URL for accessing your environment.

预览通知

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

logUrl (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.

预览通知

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

state (DeploymentStatusState!)

The state of the deployment.

预览通知

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.


CreateIssueInput

Autogenerated input type of CreateIssue.

输入字段

名称 描述

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

body (String)

The body for the issue description.

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelIds ([ID!])

An array of Node IDs of labels for this issue.

milestoneId (ID)

The Node ID of the milestone for this issue.

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

repositoryId (ID!)

The Node ID of the repository.

title (String!)

The title for the issue.


CreateLabelInput

Autogenerated input type of CreateLabel.

预览通知

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

预览通知

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

description (String)

A brief description of the label, such as its purpose.

预览通知

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

name (String!)

The name of the label.

预览通知

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

repositoryId (ID!)

The Node ID of the repository.

预览通知

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.


CreateProjectInput

Autogenerated input type of CreateProject.

输入字段

名称 描述

body (String)

The description of project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of project.

ownerId (ID!)

The owner ID to create the project under.

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

template (ProjectTemplate)

The name of the GitHub-provided template.


CreatePullRequestInput

Autogenerated input type of CreatePullRequest.

输入字段

名称 描述

baseRefName (String!)

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.

body (String)

The contents of the pull request.

clientMutationId (String)

A unique identifier for the client performing the mutation.

draft (Boolean)

Indicates whether this pull request should be a draft.

headRefName (String!)

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.

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

repositoryId (ID!)

The Node ID of the repository.

title (String!)

The title of the pull request.


CreateRefInput

Autogenerated input type of CreateRef.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.


CreateRepositoryInput

Autogenerated input type of CreateRepository.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A short description of the new repository.

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

homepageUrl (URI)

The URL for a web page about this repository.

name (String!)

The name of the new repository.

ownerId (ID)

The ID of the owner for the new repository.

teamId (ID)

When an organization is specified as the owner, this ID identifies the team that should be granted access to the new repository.

template (Boolean)

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.

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.


CreateTeamDiscussionCommentInput

Autogenerated input type of CreateTeamDiscussionComment.

输入字段

名称 描述

body (String!)

The content of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

The ID of the discussion to which the comment belongs.


CreateTeamDiscussionInput

Autogenerated input type of CreateTeamDiscussion.

输入字段

名称 描述

body (String!)

The content of the discussion.

clientMutationId (String)

A unique identifier for the client performing the mutation.

private (Boolean)

If true, restricts the visiblity of this discussion to team members and organization admins. If false or not specified, allows any organization member to view this discussion.

teamId (ID!)

The ID of the team to which the discussion belongs.

title (String!)

The title of the discussion.


DeleteBranchProtectionRuleInput

Autogenerated input type of DeleteBranchProtectionRule.

输入字段

名称 描述

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

clientMutationId (String)

A unique identifier for the client performing the mutation.


DeleteIssueCommentInput

Autogenerated input type of DeleteIssueComment.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the comment to delete.


DeleteIssueInput

Autogenerated input type of DeleteIssue.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The ID of the issue to delete.


DeleteLabelInput

Autogenerated input type of DeleteLabel.

预览通知

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

id (ID!)

The Node ID of the label to be deleted.

预览通知

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.


DeleteProjectCardInput

Autogenerated input type of DeleteProjectCard.

输入字段

名称 描述

cardId (ID!)

The id of the card to delete.

clientMutationId (String)

A unique identifier for the client performing the mutation.


DeleteProjectColumnInput

Autogenerated input type of DeleteProjectColumn.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to delete.


DeleteProjectInput

Autogenerated input type of DeleteProject.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The Project ID to update.


DeletePullRequestReviewCommentInput

Autogenerated input type of DeletePullRequestReviewComment.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the comment to delete.


DeletePullRequestReviewInput

Autogenerated input type of DeletePullRequestReview.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.


DeleteRefInput

Autogenerated input type of DeleteRef.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

refId (ID!)

The Node ID of the Ref to be deleted.


DeleteTeamDiscussionCommentInput

Autogenerated input type of DeleteTeamDiscussionComment.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the comment to delete.


DeleteTeamDiscussionInput

Autogenerated input type of DeleteTeamDiscussion.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The discussion ID to delete.


DeploymentOrder

Ordering options for deployment connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (DeploymentOrderField!)

The field to order deployments by.


DismissPullRequestReviewInput

Autogenerated input type of DismissPullRequestReview.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String!)

The contents of the pull request review dismissal message.

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.


DraftPullRequestReviewComment

Specifies a review comment to be left with a Pull Request Review.

输入字段

名称 描述

body (String!)

Body of the comment to leave.

path (String!)

Path to the file being commented on.

position (Int!)

Position in the file to leave a comment on.


DraftPullRequestReviewThread

Specifies a review comment thread to be left with a Pull Request Review.

输入字段

名称 描述

body (String!)

Body of the comment to leave.

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

path (String!)

Path to the file being commented on.

side (DiffSide)

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.

startLine (Int)

The first line of the range to which the comment refers.

startSide (DiffSide)

The side of the diff on which the start line resides.


EnterpriseAdministratorInvitationOrder

Ordering options for enterprise administrator invitation connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.


EnterpriseMemberOrder

Ordering options for enterprise member connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.


EnterpriseServerUserAccountEmailOrder

Ordering options for Enterprise Server user account email connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.


EnterpriseServerUserAccountOrder

Ordering options for Enterprise Server user account connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.


EnterpriseServerUserAccountsUploadOrder

Ordering options for Enterprise Server user accounts upload connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.


FollowUserInput

Autogenerated input type of FollowUser.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

userId (ID!)

ID of the user to follow.


GistOrder

Ordering options for gist connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (GistOrderField!)

The field to order repositories by.


ImportProjectInput

Autogenerated input type of ImportProject.

输入字段

名称 描述

body (String)

The description of Project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

name (String!)

The name of Project.

ownerName (String!)

The name of the Organization or User to create the Project under.

public (Boolean)

Whether the Project is public or not.


IssueFilters

Ways in which to filter lists of issues.

输入字段

名称 描述

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned user, and * for issues assigned to any user.

createdBy (String)

List issues created by given name.

labels ([String!])

List issues where the list of label names exist on the issue.

mentioned (String)

List issues where the given name is mentioned in the issue.

milestone (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.

since (DateTime)

List issues that have been updated at or after the given date.

states ([IssueState!])

List issues filtered by the list of states given.

viewerSubscribed (Boolean)

List issues subscribed to by viewer.


IssueOrder

Ways in which lists of issues can be ordered upon return.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order issues by the specified field.

field (IssueOrderField!)

The field in which to order issues by.


LabelOrder

Ways in which lists of labels can be ordered upon return.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order labels by the specified field.

field (LabelOrderField!)

The field in which to order labels by.


LanguageOrder

Ordering options for language connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (LanguageOrderField!)

The field to order languages by.


LinkRepositoryToProjectInput

Autogenerated input type of LinkRepositoryToProject.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to link to a Repository.

repositoryId (ID!)

The ID of the Repository to link to a Project.


LockLockableInput

Autogenerated input type of LockLockable.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockReason (LockReason)

A reason for why the issue or pull request will be locked.

lockableId (ID!)

ID of the issue or pull request to be locked.


MarkPullRequestReadyForReviewInput

Autogenerated input type of MarkPullRequestReadyForReview.

预览通知

MarkPullRequestReadyForReviewInput is available under the Draft pull requests preview. During the preview period, the API may change without notice.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

MarkPullRequestReadyForReviewInput is available under the Draft pull requests preview. During the preview period, the API may change without notice.

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

预览通知

MarkPullRequestReadyForReviewInput is available under the Draft pull requests preview. During the preview period, the API may change without notice.


MergeBranchInput

Autogenerated input type of MergeBranch.

输入字段

名称 描述

base (String!)

The name of the base branch that the provided head will be merged into.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.


MergePullRequestInput

Autogenerated input type of MergePullRequest.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

pullRequestId (ID!)

ID of the pull request to be merged.


MilestoneOrder

Ordering options for milestone connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (MilestoneOrderField!)

The field to order milestones by.


MinimizeCommentInput

Autogenerated input type of MinimizeComment.

输入字段

名称 描述

classifier (ReportedContentClassifiers!)

The classification of comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the subject to modify.


MoveProjectCardInput

Autogenerated input type of MoveProjectCard.

输入字段

名称 描述

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

cardId (ID!)

The id of the card to move.

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to move it into.


MoveProjectColumnInput

Autogenerated input type of MoveProjectColumn.

输入字段

名称 描述

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to move.


OrganizationOrder

Ordering options for organization connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (OrganizationOrderField!)

The field to order organizations by.


PackageFileOrder

Ways in which lists of package files can be ordered upon return.

预览通知

PackageFileOrder is available under the GitHub packages preview. During the preview period, the API may change without notice.

输入字段

名称 描述

direction (OrderDirection)

The direction in which to order package files by the specified field.

预览通知

PackageFileOrder is available under the GitHub packages preview. During the preview period, the API may change without notice.

field (PackageFileOrderField)

The field in which to order package files by.

预览通知

PackageFileOrder is available under the GitHub packages preview. During the preview period, the API may change without notice.


PackageOrder

Ways in which lists of packages can be ordered upon return.

预览通知

PackageOrder is available under the GitHub packages preview. During the preview period, the API may change without notice.

输入字段

名称 描述

direction (OrderDirection)

The direction in which to order packages by the specified field.

预览通知

PackageOrder is available under the GitHub packages preview. During the preview period, the API may change without notice.

field (PackageOrderField)

The field in which to order packages by.

预览通知

PackageOrder is available under the GitHub packages preview. During the preview period, the API may change without notice.


PackageVersionOrder

Ways in which lists of package versions can be ordered upon return.

预览通知

PackageVersionOrder is available under the GitHub packages preview. During the preview period, the API may change without notice.

输入字段

名称 描述

direction (OrderDirection)

The direction in which to order package versions by the specified field.

预览通知

PackageVersionOrder is available under the GitHub packages preview. During the preview period, the API may change without notice.

field (PackageVersionOrderField)

The field in which to order package versions by.

预览通知

PackageVersionOrder is available under the GitHub packages preview. During the preview period, the API may change without notice.


PinIssueInput

Autogenerated input type of PinIssue.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The ID of the issue to be pinned.


ProjectCardImport

An issue or PR and its owning repository to be used in a project card.

输入字段

名称 描述

number (Int!)

The issue or pull request number.

repository (String!)

Repository name with owner (owner/repository).


ProjectColumnImport

A project column and a list of its issues and PRs.

输入字段

名称 描述

columnName (String!)

The name of the column.

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

position (Int!)

The position of the column, starting from 0.


ProjectOrder

Ways in which lists of projects can be ordered upon return.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order projects by the specified field.

field (ProjectOrderField!)

The field in which to order projects by.


PullRequestOrder

Ways in which lists of issues can be ordered upon return.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

field (PullRequestOrderField!)

The field in which to order pull requests by.


ReactionOrder

Ways in which lists of reactions can be ordered upon return.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

field (ReactionOrderField!)

The field in which to order reactions by.


RefOrder

Ways in which lists of git refs can be ordered upon return.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order refs by the specified field.

field (RefOrderField!)

The field in which to order refs by.


RefUpdate

A ref update.

预览通知

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

输入字段

名称 描述

afterOid (GitObjectID!)

The value this ref should be updated to.

预览通知

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

预览通知

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

force (Boolean)

Force a non fast-forward update.

预览通知

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

预览通知

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.


RegistryPackageMetadatum

Represents a single registry metadatum.

输入字段

名称 描述

name (String!)

Name of the metadatum.

update (Boolean)

True, if the metadatum can be updated if it already exists.

value (String!)

Value of the metadatum.


ReleaseOrder

Ways in which lists of releases can be ordered upon return.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order releases by the specified field.

field (ReleaseOrderField!)

The field in which to order releases by.


RemoveAssigneesFromAssignableInput

Autogenerated input type of RemoveAssigneesFromAssignable.

输入字段

名称 描述

assignableId (ID!)

The id of the assignable object to remove assignees from.

assigneeIds ([ID!]!)

The id of users to remove as assignees.

clientMutationId (String)

A unique identifier for the client performing the mutation.


RemoveEnterpriseAdminInput

Autogenerated input type of RemoveEnterpriseAdmin.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

login (String!)

The login of the user to remove as an administrator.


RemoveLabelsFromLabelableInput

Autogenerated input type of RemoveLabelsFromLabelable.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelIds ([ID!]!)

The ids of labels to remove.

labelableId (ID!)

The id of the Labelable to remove labels from.


RemoveOutsideCollaboratorInput

Autogenerated input type of RemoveOutsideCollaborator.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

userId (ID!)

The ID of the outside collaborator to remove.


RemoveReactionInput

Autogenerated input type of RemoveReaction.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

content (ReactionContent!)

The name of the emoji reaction to remove.

subjectId (ID!)

The Node ID of the subject to modify.


RemoveStarInput

Autogenerated input type of RemoveStar.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to unstar.


ReopenIssueInput

Autogenerated input type of ReopenIssue.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

ID of the issue to be opened.


ReopenPullRequestInput

Autogenerated input type of ReopenPullRequest.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to be reopened.


RepositoryInvitationOrder

Ordering options for repository invitation connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.


RepositoryOrder

Ordering options for repository connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (RepositoryOrderField!)

The field to order repositories by.


RequestReviewsInput

Autogenerated input type of RequestReviews.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

The Node ID of the pull request to modify.

teamIds ([ID!])

The Node IDs of the team to request.

union (Boolean)

Add users to the set rather than replace.

userIds ([ID!])

The Node IDs of the user to request.


RerequestCheckSuiteInput

Autogenerated input type of RerequestCheckSuite.

预览通知

RerequestCheckSuiteInput is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

checkSuiteId (ID!)

The Node ID of the check suite.

预览通知

RerequestCheckSuiteInput is available under the Checks preview. During the preview period, the API may change without notice.

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

RerequestCheckSuiteInput is available under the Checks preview. During the preview period, the API may change without notice.

repositoryId (ID!)

The Node ID of the repository.

预览通知

RerequestCheckSuiteInput is available under the Checks preview. During the preview period, the API may change without notice.


ResolveReviewThreadInput

Autogenerated input type of ResolveReviewThread.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

threadId (ID!)

The ID of the thread to resolve.


SavedReplyOrder

Ordering options for saved reply connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (SavedReplyOrderField!)

The field to order saved replies by.


SponsorshipOrder

Ordering options for sponsorship connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.


StarOrder

Ways in which star connections can be ordered.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order nodes.

field (StarOrderField!)

The field in which to order nodes by.


SubmitPullRequestReviewInput

Autogenerated input type of SubmitPullRequestReview.

输入字段

名称 描述

body (String)

The text field to set on the Pull Request Review.

clientMutationId (String)

A unique identifier for the client performing the mutation.

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

pullRequestReviewId (ID!)

The Pull Request Review ID to submit.


TeamDiscussionCommentOrder

Ways in which team discussion comment connections can be ordered.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order nodes.

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.


TeamDiscussionOrder

Ways in which team discussion connections can be ordered.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order nodes.

field (TeamDiscussionOrderField!)

The field by which to order nodes.


TeamMemberOrder

Ordering options for team member connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (TeamMemberOrderField!)

The field to order team members by.


TeamOrder

Ways in which team connections can be ordered.

输入字段

名称 描述

direction (OrderDirection!)

The direction in which to order nodes.

field (TeamOrderField!)

The field in which to order nodes by.


TeamRepositoryOrder

Ordering options for team repository connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (TeamRepositoryOrderField!)

The field to order repositories by.


TransferIssueInput

Autogenerated input type of TransferIssue.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The Node ID of the issue to be transferred.

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.


UnarchiveRepositoryInput

Autogenerated input type of UnarchiveRepository.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The ID of the repository to unarchive.


UnfollowUserInput

Autogenerated input type of UnfollowUser.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

userId (ID!)

ID of the user to unfollow.


UnlinkRepositoryFromProjectInput

Autogenerated input type of UnlinkRepositoryFromProject.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project linked to the Repository.

repositoryId (ID!)

The ID of the Repository linked to the Project.


UnlockLockableInput

Autogenerated input type of UnlockLockable.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockableId (ID!)

ID of the issue or pull request to be unlocked.


UnmarkIssueAsDuplicateInput

Autogenerated input type of UnmarkIssueAsDuplicate.

输入字段

名称 描述

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

clientMutationId (String)

A unique identifier for the client performing the mutation.

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.


UnminimizeCommentInput

Autogenerated input type of UnminimizeComment.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the subject to modify.


UnpinIssueInput

Autogenerated input type of UnpinIssue.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The ID of the issue to be unpinned.


UnresolveReviewThreadInput

Autogenerated input type of UnresolveReviewThread.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

threadId (ID!)

The ID of the thread to unresolve.


UpdateBranchProtectionRuleInput

Autogenerated input type of UpdateBranchProtectionRule.

输入字段

名称 描述

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

clientMutationId (String)

A unique identifier for the client performing the mutation.

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

pattern (String)

The glob-like pattern used to determine matching branches.

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

requiresCommitSignatures (Boolean)

Are commits required to be signed.

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.


UpdateCheckRunInput

Autogenerated input type of UpdateCheckRun.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

checkRunId (ID!)

The node of the check.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

completedAt (DateTime)

The time that the check run finished.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

conclusion (CheckConclusionState)

The final conclusion of the check.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

externalId (String)

A reference for the run on the integrator's system.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

name (String)

The name of the check.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

output (CheckRunOutput)

Descriptive details about the run.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

repositoryId (ID!)

The node ID of the repository.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

startedAt (DateTime)

The time that the check run began.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.

status (RequestableCheckStatusState)

The current status.

预览通知

UpdateCheckRunInput is available under the Checks preview. During the preview period, the API may change without notice.


UpdateCheckSuitePreferencesInput

Autogenerated input type of UpdateCheckSuitePreferences.

预览通知

UpdateCheckSuitePreferencesInput is available under the Checks preview. During the preview period, the API may change without notice.

输入字段

名称 描述

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

预览通知

UpdateCheckSuitePreferencesInput is available under the Checks preview. During the preview period, the API may change without notice.

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

UpdateCheckSuitePreferencesInput is available under the Checks preview. During the preview period, the API may change without notice.

repositoryId (ID!)

The Node ID of the repository.

预览通知

UpdateCheckSuitePreferencesInput is available under the Checks preview. During the preview period, the API may change without notice.


UpdateEnterpriseActionExecutionCapabilitySettingInput

Autogenerated input type of UpdateEnterpriseActionExecutionCapabilitySetting.

输入字段

名称 描述

capability (ActionExecutionCapabilitySetting!)

The value for the action execution capability setting on the enterprise.

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.


UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.


UpdateEnterpriseDefaultRepositoryPermissionSettingInput

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the default repository permission setting.

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the default repository permission setting on the enterprise.


UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.


UpdateEnterpriseMembersCanCreateRepositoriesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This or the granular public/private/internal allowed fields (but not both) must be provided.


UpdateEnterpriseMembersCanDeleteIssuesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.


UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.


UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.


UpdateEnterpriseMembersCanMakePurchasesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.


UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.


UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.


UpdateEnterpriseOrganizationProjectsSettingInput

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.


UpdateEnterpriseProfileInput

Autogenerated input type of UpdateEnterpriseProfile.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

The description of the enterprise.

enterpriseId (ID!)

The Enterprise ID to update.

location (String)

The location of the enterprise.

name (String)

The name of the enterprise.

websiteUrl (String)

The URL of the enterprise's website.


UpdateEnterpriseRepositoryProjectsSettingInput

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.


UpdateEnterpriseTeamDiscussionsSettingInput

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.


UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.


UpdateIssueCommentInput

Autogenerated input type of UpdateIssueComment.

输入字段

名称 描述

body (String!)

The updated text of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the IssueComment to modify.


UpdateIssueInput

Autogenerated input type of UpdateIssue.

输入字段

名称 描述

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

body (String)

The body for the issue description.

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the Issue to modify.

labelIds ([ID!])

An array of Node IDs of labels for this issue.

milestoneId (ID)

The Node ID of the milestone for this issue.

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

state (IssueState)

The desired issue state.

title (String)

The title for the issue.


UpdateLabelInput

Autogenerated input type of UpdateLabel.

预览通知

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

预览通知

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

description (String)

A brief description of the label, such as its purpose.

预览通知

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

id (ID!)

The Node ID of the label to be updated.

预览通知

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

name (String)

The updated name of the label.

预览通知

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.


UpdateProjectCardInput

Autogenerated input type of UpdateProjectCard.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

note (String)

The note of ProjectCard.

projectCardId (ID!)

The ProjectCard ID to update.


UpdateProjectColumnInput

Autogenerated input type of UpdateProjectColumn.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of project column.

projectColumnId (ID!)

The ProjectColumn ID to update.


UpdateProjectInput

Autogenerated input type of UpdateProject.

输入字段

名称 描述

body (String)

The description of project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String)

The name of project.

projectId (ID!)

The Project ID to update.

public (Boolean)

Whether the project is public or not.

state (ProjectState)

Whether the project is open or closed.


UpdatePullRequestInput

Autogenerated input type of UpdatePullRequest.

输入字段

名称 描述

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository.

body (String)

The contents of the pull request.

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

milestoneId (ID)

The Node ID of the milestone for this pull request.

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

pullRequestId (ID!)

The Node ID of the pull request.

state (PullRequestUpdateState)

The target state of the pull request.

title (String)

The title of the pull request.


UpdatePullRequestReviewCommentInput

Autogenerated input type of UpdatePullRequestReviewComment.

输入字段

名称 描述

body (String!)

The text of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.


UpdatePullRequestReviewInput

Autogenerated input type of UpdatePullRequestReview.

输入字段

名称 描述

body (String!)

The contents of the pull request review body.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.


UpdateRefInput

Autogenerated input type of UpdateRef.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

refId (ID!)

The Node ID of the Ref to be updated.


UpdateRefsInput

Autogenerated input type of UpdateRefs.

预览通知

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

refUpdates ([RefUpdate!]!)

A list of ref updates.

预览通知

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

repositoryId (ID!)

The Node ID of the repository.

预览通知

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.


UpdateRepositoryInput

Autogenerated input type of UpdateRepository.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

name (String)

The new name of the repository.

repositoryId (ID!)

The ID of the repository to update.

template (Boolean)

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.


UpdateSubscriptionInput

Autogenerated input type of UpdateSubscription.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

state (SubscriptionState!)

The new state of the subscription.

subscribableId (ID!)

The Node ID of the subscribable object to modify.


UpdateTeamDiscussionCommentInput

Autogenerated input type of UpdateTeamDiscussionComment.

输入字段

名称 描述

body (String!)

The updated text of the comment.

bodyVersion (String)

The current version of the body content.

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the comment to modify.


UpdateTeamDiscussionInput

Autogenerated input type of UpdateTeamDiscussion.

输入字段

名称 描述

body (String)

The updated text of the discussion.

bodyVersion (String)

The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the discussion to modify.

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

title (String)

The updated title of the discussion.


UpdateTeamReviewAssignmentInput

Autogenerated input type of UpdateTeamReviewAssignment.

预览通知

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

输入字段

名称 描述

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

预览通知

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

clientMutationId (String)

A unique identifier for the client performing the mutation.

预览通知

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

enabled (Boolean!)

Turn on or off review assignment.

预览通知

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

预览通知

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

id (ID!)

The Node ID of the team to update review assginments of.

预览通知

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

预览通知

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

teamMemberCount (Int)

The number of team members to assign.

预览通知

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.


UpdateTopicsInput

Autogenerated input type of UpdateTopics.

输入字段

名称 描述

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The Node ID of the repository.

topicNames ([String!]!)

An array of topic names.


UserStatusOrder

Ordering options for user status connections.

输入字段

名称 描述

direction (OrderDirection!)

The ordering direction.

field (UserStatusOrderField!)

The field to order user statuses by.