Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.
В настоящее время GitHub AE находится в ограниченном выпуске.

Входные объекты

В этой статье

Входные объекты можно описать как составные, так как они включают набор входных полей, определяющих объект.

About input objects

Input objects can be described as "composable objects" because they include a set of input fields that define the object.

For example, CommitAuthor takes a field called emails. Providing a value for emails transforms CommitAuthor into a list of User objects containing that email address. Note that objects may have input objects, whereas mutations require input objects.

For more information, see "Forming calls with GraphQL."

AbortQueuedMigrationsInput

Autogenerated input type of AbortQueuedMigrations.

Поля ввода для AbortQueuedMigrationsInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the organization that is running the migrations.

AddAssigneesToAssignableInput

Autogenerated input type of AddAssigneesToAssignable.

Поля ввода для AddAssigneesToAssignableInput

ИмяОписание

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.

Поля ввода для AddCommentInput

ИмяОписание

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.

AddDiscussionCommentInput

Autogenerated input type of AddDiscussionComment.

Поля ввода для AddDiscussionCommentInput

ИмяОписание

body (String!)

The contents of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

The Node ID of the discussion to comment on.

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

AddEnterpriseAdminInput

Autogenerated input type of AddEnterpriseAdmin.

Поля ввода для AddEnterpriseAdminInput

ИмяОписание

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.

AddEnterpriseOrganizationMemberInput

Autogenerated input type of AddEnterpriseOrganizationMember.

Поля ввода для AddEnterpriseOrganizationMemberInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise which owns the organization.

organizationId (ID!)

The ID of the organization the users will be added to.

role (OrganizationMemberRole)

The role to assign the users in the organization.

userIds ([ID!]!)

The IDs of the enterprise members to add.

AddLabelsToLabelableInput

Autogenerated input type of AddLabelsToLabelable.

Поля ввода для AddLabelsToLabelableInput

ИмяОписание

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.

Поля ввода для AddProjectCardInput

ИмяОписание

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.

Поля ввода для AddProjectColumnInput

ИмяОписание

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.

Поля ввода для AddPullRequestReviewCommentInput

ИмяОписание

body (String)

The text of the comment. This field is required

Upcoming Change on 2023-10-01 UTC Description: body will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitOID (GitObjectID)

The SHA of the commit to comment on.

Upcoming Change on 2023-10-01 UTC Description: commitOID will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

inReplyTo (ID)

The comment id to reply to.

Upcoming Change on 2023-10-01 UTC Description: inReplyTo will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

path (String)

The relative path of the file to comment on.

Upcoming Change on 2023-10-01 UTC Description: path will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

position (Int)

The line index in the diff to comment on.

Upcoming Change on 2023-10-01 UTC Description: position will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

pullRequestId (ID)

The node ID of the pull request reviewing

Upcoming Change on 2023-10-01 UTC Description: pullRequestId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

pullRequestReviewId (ID)

The Node ID of the review to modify.

Upcoming Change on 2023-10-01 UTC Description: pullRequestReviewId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

AddPullRequestReviewInput

Autogenerated input type of AddPullRequestReview.

Поля ввода для AddPullRequestReviewInput

ИмяОписание

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.

Upcoming Change on 2023-10-01 UTC Description: comments will be removed. use the threads argument instead Reason: We are deprecating comment fields that use diff-relative positioning.

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

ИмяОписание

body (String!)

Body of the thread's first comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

line (Int)

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

path (String!)

Path to the file being commented on.

pullRequestId (ID)

The node ID of the pull request reviewing.

pullRequestReviewId (ID)

The Node ID of the review to modify.

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.

subjectType (PullRequestReviewThreadSubjectType)

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

AddReactionInput

Autogenerated input type of AddReaction.

Поля ввода для AddReactionInput

ИмяОписание

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.

Поля ввода для AddStarInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to star.

AddUpvoteInput

Autogenerated input type of AddUpvote.

Поля ввода для AddUpvoteInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

ApproveDeploymentsInput

Autogenerated input type of ApproveDeployments.

Поля ввода для ApproveDeploymentsInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (String)

Optional comment for approving deployments.

environmentIds ([ID!]!)

The ids of environments to reject deployments.

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

ArchiveRepositoryInput

Autogenerated input type of ArchiveRepository.

Поля ввода для ArchiveRepositoryInput

ИмяОписание

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.

Поля ввода для AuditLogOrder

ИмяОписание

direction (OrderDirection)

The ordering direction.

field (AuditLogOrderField)

The field to order Audit Logs by.

BranchNamePatternParametersInput

Parameters to be used for the branch_name_pattern rule.

Поля ввода для BranchNamePatternParametersInput

ИмяОписание

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

ChangeUserStatusInput

Autogenerated input type of ChangeUserStatus.

Поля ввода для ChangeUserStatusInput

ИмяОписание

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

ИмяОписание

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

location (CheckAnnotationRange!)

The location of the annotation.

message (String!)

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

path (String!)

The path of the file to add an annotation to.

rawDetails (String)

Details about this annotation.

title (String)

The title that represents the annotation.

CheckAnnotationRange

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

Поля ввода для CheckAnnotationRange

ИмяОписание

endColumn (Int)

The ending column of the range.

endLine (Int!)

The ending line of the range.

startColumn (Int)

The starting column of the range.

startLine (Int!)

The starting line of the range.

CheckRunAction

Possible further actions the integrator can perform.

Поля ввода для CheckRunAction

ИмяОписание

description (String!)

A short explanation of what this action would do.

identifier (String!)

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

label (String!)

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

CheckRunFilter

The filters that are available when fetching check runs.

Поля ввода для CheckRunFilter

ИмяОписание

appId (Int)

Filters the check runs created by this application ID.

checkName (String)

Filters the check runs by this name.

checkType (CheckRunType)

Filters the check runs by this type.

conclusions ([CheckConclusionState!])

Filters the check runs by these conclusions.

status (CheckStatusState)

Filters the check runs by this status. Superceded by statuses.

statuses ([CheckStatusState!])

Filters the check runs by this status. Overrides status.

CheckRunOutput

Descriptive details about the check run.

Поля ввода для CheckRunOutput

ИмяОписание

annotations ([CheckAnnotationData!])

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

images ([CheckRunOutputImage!])

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

summary (String!)

The summary of the check run (supports Commonmark).

text (String)

The details of the check run (supports Commonmark).

title (String!)

A title to provide for this check run.

CheckRunOutputImage

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

Поля ввода для CheckRunOutputImage

ИмяОписание

alt (String!)

The alternative text for the image.

caption (String)

A short image description.

imageUrl (URI!)

The full URL of the image.

CheckSuiteAutoTriggerPreference

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

Поля ввода для CheckSuiteAutoTriggerPreference

ИмяОписание

appId (ID!)

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

setting (Boolean!)

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

CheckSuiteFilter

The filters that are available when fetching check suites.

Поля ввода для CheckSuiteFilter

ИмяОписание

appId (Int)

Filters the check suites created by this application ID.

checkName (String)

Filters the check suites by this name.

ClearLabelsFromLabelableInput

Autogenerated input type of ClearLabelsFromLabelable.

Поля ввода для ClearLabelsFromLabelableInput

ИмяОписание

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.

Поля ввода для CloneProjectInput

ИмяОписание

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.

Поля ввода для CloneTemplateRepositoryInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A short description of the new repository.

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults to copying only the default branch of the template.

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.

CloseDiscussionInput

Autogenerated input type of CloseDiscussion.

Поля ввода для CloseDiscussionInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

ID of the discussion to be closed.

reason (DiscussionCloseReason)

The reason why the discussion is being closed.

CloseIssueInput

Autogenerated input type of CloseIssue.

Поля ввода для CloseIssueInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

ID of the issue to be closed.

stateReason (IssueClosedStateReason)

The reason the issue is to be closed.

ClosePullRequestInput

Autogenerated input type of ClosePullRequest.

Поля ввода для ClosePullRequestInput

ИмяОписание

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.

Поля ввода для CommitAuthor

ИмяОписание

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.

CommitAuthorEmailPatternParametersInput

Parameters to be used for the commit_author_email_pattern rule.

Поля ввода для CommitAuthorEmailPatternParametersInput

ИмяОписание

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

CommitContributionOrder

Ordering options for commit contribution connections.

Поля ввода для CommitContributionOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (CommitContributionOrderField!)

The field by which to order commit contributions.

CommitMessage

A message to include with a new commit.

Поля ввода для CommitMessage

ИмяОписание

body (String)

The body of the message.

headline (String!)

The headline of the message.

CommitMessagePatternParametersInput

Parameters to be used for the commit_message_pattern rule.

Поля ввода для CommitMessagePatternParametersInput

ИмяОписание

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

CommittableBranch

A git ref for a commit to be appended to.

The ref must be a branch, i.e. its fully qualified name must start with refs/heads/ (although the input is not required to be fully qualified).

The Ref may be specified by its global node ID or by the repositoryNameWithOwner and branchName.

Examples

Specify a branch using a global node ID:

{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }

Specify a branch using repositoryNameWithOwner and branchName:

{
  "repositoryNameWithOwner": "github/graphql-client",
  "branchName": "main"
}.

Поля ввода для CommittableBranch

ИмяОписание

branchName (String)

The unqualified name of the branch to append the commit to.

id (ID)

The Node ID of the Ref to be updated.

repositoryNameWithOwner (String)

The nameWithOwner of the repository to commit to.

CommitterEmailPatternParametersInput

Parameters to be used for the committer_email_pattern rule.

Поля ввода для CommitterEmailPatternParametersInput

ИмяОписание

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

ContributionOrder

Ordering options for contribution connections.

Поля ввода для ContributionOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

ConvertProjectCardNoteToIssueInput

Autogenerated input type of ConvertProjectCardNoteToIssue.

Поля ввода для ConvertProjectCardNoteToIssueInput

ИмяОписание

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.

ConvertPullRequestToDraftInput

Autogenerated input type of ConvertPullRequestToDraft.

Поля ввода для ConvertPullRequestToDraftInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to convert to draft.

CreateAttributionInvitationInput

Autogenerated input type of CreateAttributionInvitation.

Поля ввода для CreateAttributionInvitationInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The Node ID of the owner scoping the reattributable data.

sourceId (ID!)

The Node ID of the account owning the data to reattribute.

targetId (ID!)

The Node ID of the account which may claim the data.

CreateBranchProtectionRuleInput

Autogenerated input type of CreateBranchProtectionRule.

Поля ввода для CreateBranchProtectionRuleInput

ИмяОписание

allowsDeletions (Boolean)

Can this branch be deleted.

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

blocksCreations (Boolean)

Is branch creation a protected operation.

bypassForcePushActorIds ([ID!])

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

bypassPullRequestActorIds ([ID!])

A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.

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.

lockAllowsFetchAndMerge (Boolean)

Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing.

lockBranch (Boolean)

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

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.

requireLastPushApproval (Boolean)

Whether the most recent push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

requiredDeploymentEnvironments ([String!])

The list of required deployment environments.

requiredStatusCheckContexts ([String!])

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

requiredStatusChecks ([RequiredStatusCheckInput!])

The list of required status checks.

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.

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

requiresDeployments (Boolean)

Are successful deployments required before merging.

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

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, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.

CreateCheckRunInput

Autogenerated input type of CreateCheckRun.

Поля ввода для CreateCheckRunInput

ИмяОписание

actions ([CheckRunAction!])

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

completedAt (DateTime)

The time that the check run finished.

conclusion (CheckConclusionState)

The final conclusion of the check.

detailsUrl (URI)

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

externalId (String)

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

headSha (GitObjectID!)

The SHA of the head commit.

name (String!)

The name of the check.

output (CheckRunOutput)

Descriptive details about the run.

repositoryId (ID!)

The node ID of the repository.

startedAt (DateTime)

The time that the check run began.

status (RequestableCheckStatusState)

The current status.

CreateCheckSuiteInput

Autogenerated input type of CreateCheckSuite.

Поля ввода для CreateCheckSuiteInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

headSha (GitObjectID!)

The SHA of the head commit.

repositoryId (ID!)

The Node ID of the repository.

CreateCommitOnBranchInput

Autogenerated input type of CreateCommitOnBranch.

Поля ввода для CreateCommitOnBranchInput

ИмяОписание

branch (CommittableBranch!)

The Ref to be updated. Must be a branch.

clientMutationId (String)

A unique identifier for the client performing the mutation.

expectedHeadOid (GitObjectID!)

The git commit oid expected at the head of the branch prior to the commit.

fileChanges (FileChanges)

A description of changes to files in this commit.

message (CommitMessage!)

The commit message the be included with the commit.

CreateDeploymentInput

Autogenerated input type of CreateDeployment.

Уведомление о предварительной версии

CreateDeploymentInput is available under the Deployments preview. В течение периода предварительной версии API может изменяться без уведомления.

Поля ввода для CreateDeploymentInput

ИмяОписание

autoMerge (Boolean)

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

Short description of the deployment.

environment (String)

Name for the target deployment environment.

payload (String)

JSON payload with extra information about the deployment.

refId (ID!)

The node ID of the ref to be deployed.

repositoryId (ID!)

The node ID of the repository.

requiredContexts ([String!])

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

task (String)

Specifies a task to execute.

CreateDeploymentStatusInput

Autogenerated input type of CreateDeploymentStatus.

Уведомление о предварительной версии

CreateDeploymentStatusInput is available under the Deployments preview. В течение периода предварительной версии API может изменяться без уведомления.

Поля ввода для CreateDeploymentStatusInput

ИмяОписание

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.

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentId (ID!)

The node ID of the deployment.

description (String)

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

environment (String)

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

environmentUrl (String)

Sets the URL for accessing your environment.

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.

state (DeploymentStatusState!)

The state of the deployment.

CreateDiscussionInput

Autogenerated input type of CreateDiscussion.

Поля ввода для CreateDiscussionInput

ИмяОписание

body (String!)

The body of the discussion.

categoryId (ID!)

The id of the discussion category to associate with this discussion.

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The id of the repository on which to create the discussion.

title (String!)

The title of the discussion.

CreateEnterpriseOrganizationInput

Autogenerated input type of CreateEnterpriseOrganization.

Поля ввода для CreateEnterpriseOrganizationInput

ИмяОписание

adminLogins ([String!]!)

The logins for the administrators of the new organization.

billingEmail (String!)

The email used for sending billing receipts.

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

login (String!)

The login of the new organization.

profileName (String!)

The profile name of the new organization.

CreateEnvironmentInput

Autogenerated input type of CreateEnvironment.

Поля ввода для CreateEnvironmentInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of the environment.

repositoryId (ID!)

The node ID of the repository.

CreateIpAllowListEntryInput

Autogenerated input type of CreateIpAllowListEntry.

Поля ввода для CreateIpAllowListEntryInput

ИмяОписание

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

clientMutationId (String)

A unique identifier for the client performing the mutation.

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

name (String)

An optional name for the IP allow list entry.

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

CreateIssueInput

Autogenerated input type of CreateIssue.

Поля ввода для CreateIssueInput

ИмяОписание

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.

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

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. В течение периода предварительной версии API может изменяться без уведомления.

Поля ввода для CreateLabelInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

color (String!)

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

description (String)

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

name (String!)

The name of the label.

repositoryId (ID!)

The Node ID of the repository.

CreateLinkedBranchInput

Autogenerated input type of CreateLinkedBranch.

Поля ввода для CreateLinkedBranchInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

ID of the issue to link to.

name (String)

The name of the new branch. Defaults to issue number and title.

oid (GitObjectID!)

The commit SHA to base the new branch on.

repositoryId (ID)

ID of the repository to create the branch in. Defaults to the issue repository.

CreateMigrationSourceInput

Autogenerated input type of CreateMigrationSource.

Поля ввода для CreateMigrationSourceInput

ИмяОписание

accessToken (String)

The migration source access token.

clientMutationId (String)

A unique identifier for the client performing the mutation.

githubPat (String)

The GitHub personal access token of the user importing to the target repository.

name (String!)

The migration source name.

ownerId (ID!)

The ID of the organization that will own the migration source.

type (MigrationSourceType!)

The migration source type.

url (String)

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

CreateProjectInput

Autogenerated input type of CreateProject.

Поля ввода для CreateProjectInput

ИмяОписание

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.

Поля ввода для CreatePullRequestInput

ИмяОписание

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.

headRepositoryId (ID)

The Node ID of the head repository.

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.

Поля ввода для CreateRefInput

ИмяОписание

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.

Поля ввода для CreateRepositoryInput

ИмяОписание

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.

CreateRepositoryRulesetInput

Autogenerated input type of CreateRepositoryRuleset.

Поля ввода для CreateRepositoryRulesetInput

ИмяОписание

bypassActorIds ([ID!])

A list of Team or App IDs allowed to bypass rules in this ruleset.

bypassMode (RuleBypassMode)

The bypass mode for this ruleset.

clientMutationId (String)

A unique identifier for the client performing the mutation.

conditions (RepositoryRuleConditionsInput!)

The set of conditions for this ruleset.

enforcement (RuleEnforcement!)

The enforcement level for this ruleset.

name (String!)

The name of the ruleset.

rules ([RepositoryRuleInput!])

The list of rules for this ruleset.

sourceId (ID!)

The global relay id of the source in which a new ruleset should be created in.

target (RepositoryRulesetTarget)

The target of the ruleset.

CreateTeamDiscussionCommentInput

Autogenerated input type of CreateTeamDiscussionComment.

Поля ввода для CreateTeamDiscussionCommentInput

ИмяОписание

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.

Поля ввода для CreateTeamDiscussionInput

ИмяОписание

body (String!)

The content of the discussion.

clientMutationId (String)

A unique identifier for the client performing the mutation.

private (Boolean)

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

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.

Поля ввода для DeleteBranchProtectionRuleInput

ИмяОписание

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.

DeleteDeploymentInput

Autogenerated input type of DeleteDeployment.

Поля ввода для DeleteDeploymentInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the deployment to be deleted.

DeleteDiscussionCommentInput

Autogenerated input type of DeleteDiscussionComment.

Поля ввода для DeleteDiscussionCommentInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node id of the discussion comment to delete.

DeleteDiscussionInput

Autogenerated input type of DeleteDiscussion.

Поля ввода для DeleteDiscussionInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The id of the discussion to delete.

DeleteEnvironmentInput

Autogenerated input type of DeleteEnvironment.

Поля ввода для DeleteEnvironmentInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the environment to be deleted.

DeleteIpAllowListEntryInput

Autogenerated input type of DeleteIpAllowListEntry.

Поля ввода для DeleteIpAllowListEntryInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

DeleteIssueCommentInput

Autogenerated input type of DeleteIssueComment.

Поля ввода для DeleteIssueCommentInput

ИмяОписание

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.

Поля ввода для DeleteIssueInput

ИмяОписание

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. В течение периода предварительной версии API может изменяться без уведомления.

Поля ввода для DeleteLabelInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the label to be deleted.

DeleteLinkedBranchInput

Autogenerated input type of DeleteLinkedBranch.

Поля ввода для DeleteLinkedBranchInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

linkedBranchId (ID!)

The ID of the linked branch.

DeleteProjectCardInput

Autogenerated input type of DeleteProjectCard.

Поля ввода для DeleteProjectCardInput

ИмяОписание

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.

Поля ввода для DeleteProjectColumnInput

ИмяОписание

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.

Поля ввода для DeleteProjectInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The Project ID to update.

DeletePullRequestReviewCommentInput

Autogenerated input type of DeletePullRequestReviewComment.

Поля ввода для DeletePullRequestReviewCommentInput

ИмяОписание

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.

Поля ввода для DeletePullRequestReviewInput

ИмяОписание

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.

Поля ввода для DeleteRefInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

refId (ID!)

The Node ID of the Ref to be deleted.

DeleteRepositoryRulesetInput

Autogenerated input type of DeleteRepositoryRuleset.

Поля ввода для DeleteRepositoryRulesetInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryRulesetId (ID!)

The global relay id of the repository ruleset to be deleted.

DeleteTeamDiscussionCommentInput

Autogenerated input type of DeleteTeamDiscussionComment.

Поля ввода для DeleteTeamDiscussionCommentInput

ИмяОписание

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.

Поля ввода для DeleteTeamDiscussionInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The discussion ID to delete.

DeploymentOrder

Ordering options for deployment connections.

Поля ввода для DeploymentOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (DeploymentOrderField!)

The field to order deployments by.

DisablePullRequestAutoMergeInput

Autogenerated input type of DisablePullRequestAutoMerge.

Поля ввода для DisablePullRequestAutoMergeInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

DiscussionOrder

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

Поля ввода для DiscussionOrder

ИмяОписание

direction (OrderDirection!)

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

field (DiscussionOrderField!)

The field by which to order discussions.

DismissPullRequestReviewInput

Autogenerated input type of DismissPullRequestReview.

Поля ввода для DismissPullRequestReviewInput

ИмяОписание

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.

DismissRepositoryVulnerabilityAlertInput

Autogenerated input type of DismissRepositoryVulnerabilityAlert.

Поля ввода для DismissRepositoryVulnerabilityAlertInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

dismissReason (DismissReason!)

The reason the Dependabot alert is being dismissed.

repositoryVulnerabilityAlertId (ID!)

The Dependabot alert ID to dismiss.

DraftPullRequestReviewComment

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

Поля ввода для DraftPullRequestReviewComment

ИмяОписание

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.

Поля ввода для DraftPullRequestReviewThread

ИмяОписание

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.

EnablePullRequestAutoMergeInput

Autogenerated input type of EnablePullRequestAutoMerge.

Поля ввода для EnablePullRequestAutoMergeInput

ИмяОписание

authorEmail (String)

The email address to associate with this merge.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used. NOTE: when merging with a merge queue any input value for commit message is ignored.

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used. NOTE: when merging with a merge queue any input value for commit headline is ignored.

expectedHeadOid (GitObjectID)

The expected head OID of the pull request.

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to MERGE. NOTE: when merging with a merge queue any input value for merge method is ignored.

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

EnterpriseAdministratorInvitationOrder

Ordering options for enterprise administrator invitation connections.

Поля ввода для EnterpriseAdministratorInvitationOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

EnterpriseMemberOrder

Ordering options for enterprise member connections.

Поля ввода для EnterpriseMemberOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

EnterpriseServerInstallationOrder

Ordering options for Enterprise Server installation connections.

Поля ввода для EnterpriseServerInstallationOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerInstallationOrderField!)

The field to order Enterprise Server installations by.

EnterpriseServerUserAccountEmailOrder

Ordering options for Enterprise Server user account email connections.

Поля ввода для EnterpriseServerUserAccountEmailOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

EnterpriseServerUserAccountOrder

Ordering options for Enterprise Server user account connections.

Поля ввода для EnterpriseServerUserAccountOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

EnterpriseServerUserAccountsUploadOrder

Ordering options for Enterprise Server user accounts upload connections.

Поля ввода для EnterpriseServerUserAccountsUploadOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

FileAddition

A command to add a file at the given path with the given contents as part of a commit. Any existing file at that that path will be replaced.

Поля ввода для FileAddition

ИмяОписание

contents (Base64String!)

The base64 encoded contents of the file.

path (String!)

The path in the repository where the file will be located.

FileChanges

A description of a set of changes to a file tree to be made as part of a git commit, modeled as zero or more file additions and zero or more file deletions.

Both fields are optional; omitting both will produce a commit with no file changes.

deletions and additions describe changes to files identified by their path in the git tree using unix-style path separators, i.e. /. The root of a git tree is an empty string, so paths are not slash-prefixed.

path values must be unique across all additions and deletions provided. Any duplication will result in a validation error.

Encoding

File contents must be provided in full for each FileAddition.

The contents of a FileAddition must be encoded using RFC 4648 compliant base64, i.e. correct padding is required and no characters outside the standard alphabet may be used. Invalid base64 encoding will be rejected with a validation error.

The encoded contents may be binary.

For text files, no assumptions are made about the character encoding of the file contents (after base64 decoding). No charset transcoding or line-ending normalization will be performed; it is the client's responsibility to manage the character encoding of files they provide. However, for maximum compatibility we recommend using UTF-8 encoding and ensuring that all files in a repository use a consistent line-ending convention (\n or \r\n), and that all files end with a newline.

Modeling file changes

Each of the the five types of conceptual changes that can be made in a git commit can be described using the FileChanges type as follows:

  1. New file addition: create file hello world\n at path docs/README.txt:

    { "additions" [ { "path": "docs/README.txt", "contents": base64encode("hello world\n") } ] }

  2. Existing file modification: change existing docs/README.txt to have new content new content here\n:

    {
      "additions" [
        {
          "path": "docs/README.txt",
          "contents": base64encode("new content here\n")
        }
      ]
    }
    
  3. Existing file deletion: remove existing file docs/README.txt. Note that the path is required to exist -- specifying a path that does not exist on the given branch will abort the commit and return an error.

    {
      "deletions" [
        {
          "path": "docs/README.txt"
        }
      ]
    }
    
  4. File rename with no changes: rename docs/README.txt with previous content hello world\n to the same content at newdocs/README.txt:

    {
      "deletions" [
        {
          "path": "docs/README.txt",
        }
      ],
      "additions" [
        {
          "path": "newdocs/README.txt",
          "contents": base64encode("hello world\n")
        }
      ]
    }
    
  5. File rename with changes: rename docs/README.txt with previous content hello world\n to a file at path newdocs/README.txt with content new contents\n:

    {
      "deletions" [
        {
          "path": "docs/README.txt",
        }
      ],
      "additions" [
        {
          "path": "newdocs/README.txt",
          "contents": base64encode("new contents\n")
        }
      ]
    }.
    

Поля ввода для FileChanges

ИмяОписание

additions ([FileAddition!])

File to add or change.

deletions ([FileDeletion!])

Files to delete.

FileDeletion

A command to delete the file at the given path as part of a commit.

Поля ввода для FileDeletion

ИмяОписание

path (String!)

The path to delete.

FollowOrganizationInput

Autogenerated input type of FollowOrganization.

Поля ввода для FollowOrganizationInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

ID of the organization to follow.

FollowUserInput

Autogenerated input type of FollowUser.

Поля ввода для FollowUserInput

ИмяОписание

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.

Поля ввода для GistOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (GistOrderField!)

The field to order repositories by.

GrantEnterpriseOrganizationsMigratorRoleInput

Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.

Поля ввода для GrantEnterpriseOrganizationsMigratorRoleInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise to which all organizations managed by it will be granted the migrator role.

login (String!)

The login of the user to grant the migrator role.

GrantMigratorRoleInput

Autogenerated input type of GrantMigratorRole.

Поля ввода для GrantMigratorRoleInput

ИмяОписание

actor (String!)

The user login or Team slug to grant the migrator role.

actorType (ActorType!)

Specifies the type of the actor, can be either USER or TEAM.

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization that the user/team belongs to.

ImportProjectInput

Autogenerated input type of ImportProject.

Поля ввода для ImportProjectInput

ИмяОписание

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.

IpAllowListEntryOrder

Ordering options for IP allow list entry connections.

Поля ввода для IpAllowListEntryOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

IssueCommentOrder

Ways in which lists of issue comments can be ordered upon return.

Поля ввода для IssueCommentOrder

ИмяОписание

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

field (IssueCommentOrderField!)

The field in which to order issue comments by.

IssueFilters

Ways in which to filter lists of issues.

Поля ввода для IssueFilters

ИмяОписание

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 database ID. Pass in null for issues with no milestone, and * for issues that are assigned to any milestone.

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

Поля ввода для IssueOrder

ИмяОписание

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.

Поля ввода для LabelOrder

ИмяОписание

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.

Поля ввода для LanguageOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (LanguageOrderField!)

The field to order languages by.

LinkRepositoryToProjectInput

Autogenerated input type of LinkRepositoryToProject.

Поля ввода для LinkRepositoryToProjectInput

ИмяОписание

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.

Поля ввода для LockLockableInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockReason (LockReason)

A reason for why the item will be locked.

lockableId (ID!)

ID of the item to be locked.

MannequinOrder

Ordering options for mannequins.

Поля ввода для MannequinOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (MannequinOrderField!)

The field to order mannequins by.

MarkDiscussionCommentAsAnswerInput

Autogenerated input type of MarkDiscussionCommentAsAnswer.

Поля ввода для MarkDiscussionCommentAsAnswerInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the discussion comment to mark as an answer.

MarkFileAsViewedInput

Autogenerated input type of MarkFileAsViewed.

Поля ввода для MarkFileAsViewedInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

path (String!)

The path of the file to mark as viewed.

pullRequestId (ID!)

The Node ID of the pull request.

MarkPullRequestReadyForReviewInput

Autogenerated input type of MarkPullRequestReadyForReview.

Поля ввода для MarkPullRequestReadyForReviewInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

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

MergeBranchInput

Autogenerated input type of MergeBranch.

Поля ввода для MergeBranchInput

ИмяОписание

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.

Поля ввода для MergePullRequestInput

ИмяОписание

authorEmail (String)

The email address to associate with this merge.

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.

Поля ввода для MilestoneOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (MilestoneOrderField!)

The field to order milestones by.

MinimizeCommentInput

Autogenerated input type of MinimizeComment.

Поля ввода для MinimizeCommentInput

ИмяОписание

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.

Поля ввода для MoveProjectCardInput

ИмяОписание

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.

Поля ввода для MoveProjectColumnInput

ИмяОписание

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.

OrgEnterpriseOwnerOrder

Ordering options for an organization's enterprise owner connections.

Поля ввода для OrgEnterpriseOwnerOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (OrgEnterpriseOwnerOrderField!)

The field to order enterprise owners by.

OrganizationOrder

Ordering options for organization connections.

Поля ввода для OrganizationOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (OrganizationOrderField!)

The field to order organizations by.

PinIssueInput

Autogenerated input type of PinIssue.

Поля ввода для PinIssueInput

ИмяОписание

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.

Поля ввода для ProjectCardImport

ИмяОписание

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.

Поля ввода для ProjectColumnImport

ИмяОписание

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.

Поля ввода для ProjectOrder

ИмяОписание

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.

Поля ввода для PullRequestOrder

ИмяОписание

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.

PullRequestParametersInput

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

Поля ввода для PullRequestParametersInput

ИмяОписание

dismissStaleReviewsOnPush (Boolean!)

New, reviewable commits pushed will dismiss previous pull request review approvals.

requireCodeOwnerReview (Boolean!)

Require an approving review in pull requests that modify files that have a designated code owner.

requireLastPushApproval (Boolean!)

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount (Int!)

The number of approving reviews that are required before a pull request can be merged.

requiredReviewThreadResolution (Boolean!)

All conversations on code must be resolved before a pull request can be merged.

ReactionOrder

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

Поля ввода для ReactionOrder

ИмяОписание

direction (OrderDirection!)

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

field (ReactionOrderField!)

The field in which to order reactions by.

RefNameConditionTargetInput

Parameters to be used for the ref_name condition.

Поля ввода для RefNameConditionTargetInput

ИмяОписание

exclude ([String!]!)

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

include ([String!]!)

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

RefOrder

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

Поля ввода для RefOrder

ИмяОписание

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 update multiple refs in a single operation preview. В течение периода предварительной версии API может изменяться без уведомления.

Поля ввода для RefUpdate

ИмяОписание

afterOid (GitObjectID!)

The value this ref should be updated to.

beforeOid (GitObjectID)

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

force (Boolean)

Force a non fast-forward update.

name (GitRefname!)

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

RejectDeploymentsInput

Autogenerated input type of RejectDeployments.

Поля ввода для RejectDeploymentsInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (String)

Optional comment for rejecting deployments.

environmentIds ([ID!]!)

The ids of environments to reject deployments.

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

ReleaseOrder

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

Поля ввода для ReleaseOrder

ИмяОписание

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.

Поля ввода для RemoveAssigneesFromAssignableInput

ИмяОписание

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.

Поля ввода для RemoveEnterpriseAdminInput

ИмяОписание

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.

Поля ввода для RemoveLabelsFromLabelableInput

ИмяОписание

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.

Поля ввода для RemoveOutsideCollaboratorInput

ИмяОписание

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.

Поля ввода для RemoveReactionInput

ИмяОписание

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.

Поля ввода для RemoveStarInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to unstar.

RemoveUpvoteInput

Autogenerated input type of RemoveUpvote.

Поля ввода для RemoveUpvoteInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

ReopenDiscussionInput

Autogenerated input type of ReopenDiscussion.

Поля ввода для ReopenDiscussionInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

ID of the discussion to be reopened.

ReopenIssueInput

Autogenerated input type of ReopenIssue.

Поля ввода для ReopenIssueInput

ИмяОписание

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.

Поля ввода для ReopenPullRequestInput

ИмяОписание

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.

Поля ввода для RepositoryInvitationOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

RepositoryMigrationOrder

Ordering options for repository migrations.

Поля ввода для RepositoryMigrationOrder

ИмяОписание

direction (RepositoryMigrationOrderDirection!)

The ordering direction.

field (RepositoryMigrationOrderField!)

The field to order repository migrations by.

RepositoryNameConditionTargetInput

Parameters to be used for the repository_name condition.

Поля ввода для RepositoryNameConditionTargetInput

ИмяОписание

exclude ([String!]!)

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

include ([String!]!)

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

protected (Boolean)

Target changes that match these patterns will be prevented except by those with bypass permissions.

RepositoryOrder

Ordering options for repository connections.

Поля ввода для RepositoryOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (RepositoryOrderField!)

The field to order repositories by.

RepositoryRuleConditionsInput

Specifies the conditions required for a ruleset to evaluate.

Поля ввода для RepositoryRuleConditionsInput

ИмяОписание

refName (RefNameConditionTargetInput)

Configuration for the ref_name condition.

repositoryName (RepositoryNameConditionTargetInput)

Configuration for the repository_name condition.

RepositoryRuleInput

Specifies the attributes for a new or updated rule.

Поля ввода для RepositoryRuleInput

ИмяОписание

id (ID)

Optional ID of this rule when updating.

parameters (RuleParametersInput)

The parameters for the rule.

type (RepositoryRuleType!)

The type of rule to create.

RequestReviewsInput

Autogenerated input type of RequestReviews.

Поля ввода для RequestReviewsInput

ИмяОписание

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.

RequiredDeploymentsParametersInput

Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.

Поля ввода для RequiredDeploymentsParametersInput

ИмяОписание

requiredDeploymentEnvironments ([String!]!)

The environments that must be successfully deployed to before branches can be merged.

RequiredStatusCheckInput

Specifies the attributes for a new or updated required status check.

Поля ввода для RequiredStatusCheckInput

ИмяОписание

appId (ID)

The ID of the App that must set the status in order for it to be accepted. Omit this value to use whichever app has recently been setting this status, or use "any" to allow any app to set the status.

context (String!)

Status check context that must pass for commits to be accepted to the matching branch.

RequiredStatusChecksParametersInput

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

Поля ввода для RequiredStatusChecksParametersInput

ИмяОписание

requiredStatusChecks ([StatusCheckConfigurationInput!]!)

Status checks that are required.

strictRequiredStatusChecksPolicy (Boolean!)

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

RerequestCheckSuiteInput

Autogenerated input type of RerequestCheckSuite.

Поля ввода для RerequestCheckSuiteInput

ИмяОписание

checkSuiteId (ID!)

The Node ID of the check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The Node ID of the repository.

ResolveReviewThreadInput

Autogenerated input type of ResolveReviewThread.

Поля ввода для ResolveReviewThreadInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

threadId (ID!)

The ID of the thread to resolve.

RevokeEnterpriseOrganizationsMigratorRoleInput

Autogenerated input type of RevokeEnterpriseOrganizationsMigratorRole.

Поля ввода для RevokeEnterpriseOrganizationsMigratorRoleInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise to which all organizations managed by it will be granted the migrator role.

login (String!)

The login of the user to revoke the migrator role.

RevokeMigratorRoleInput

Autogenerated input type of RevokeMigratorRole.

Поля ввода для RevokeMigratorRoleInput

ИмяОписание

actor (String!)

The user login or Team slug to revoke the migrator role from.

actorType (ActorType!)

Specifies the type of the actor, can be either USER or TEAM.

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization that the user/team belongs to.

RuleParametersInput

Specifies the parameters for a RepositoryRule object. Only one of the fields should be specified.

Поля ввода для RuleParametersInput

ИмяОписание

branchNamePattern (BranchNamePatternParametersInput)

Parameters used for the branch_name_pattern rule type.

commitAuthorEmailPattern (CommitAuthorEmailPatternParametersInput)

Parameters used for the commit_author_email_pattern rule type.

commitMessagePattern (CommitMessagePatternParametersInput)

Parameters used for the commit_message_pattern rule type.

committerEmailPattern (CommitterEmailPatternParametersInput)

Parameters used for the committer_email_pattern rule type.

pullRequest (PullRequestParametersInput)

Parameters used for the pull_request rule type.

requiredDeployments (RequiredDeploymentsParametersInput)

Parameters used for the required_deployments rule type.

requiredStatusChecks (RequiredStatusChecksParametersInput)

Parameters used for the required_status_checks rule type.

tagNamePattern (TagNamePatternParametersInput)

Parameters used for the tag_name_pattern rule type.

update (UpdateParametersInput)

Parameters used for the update rule type.

SavedReplyOrder

Ordering options for saved reply connections.

Поля ввода для SavedReplyOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (SavedReplyOrderField!)

The field to order saved replies by.

StarOrder

Ways in which star connections can be ordered.

Поля ввода для StarOrder

ИмяОписание

direction (OrderDirection!)

The direction in which to order nodes.

field (StarOrderField!)

The field in which to order nodes by.

StartOrganizationMigrationInput

Autogenerated input type of StartOrganizationMigration.

Поля ввода для StartOrganizationMigrationInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

sourceAccessToken (String!)

The migration source access token.

sourceOrgUrl (URI!)

The URL of the organization to migrate.

targetEnterpriseId (ID!)

The ID of the enterprise the target organization belongs to.

targetOrgName (String!)

The name of the target organization.

StartRepositoryMigrationInput

Autogenerated input type of StartRepositoryMigration.

Поля ввода для StartRepositoryMigrationInput

ИмяОписание

accessToken (String)

The migration source access token.

clientMutationId (String)

A unique identifier for the client performing the mutation.

continueOnError (Boolean)

Whether to continue the migration on error. Defaults to false.

gitArchiveUrl (String)

The signed URL to access the user-uploaded git archive.

githubPat (String)

The GitHub personal access token of the user importing to the target repository.

lockSource (Boolean)

Whether to lock the source repository.

metadataArchiveUrl (String)

The signed URL to access the user-uploaded metadata archive.

ownerId (ID!)

The ID of the organization that will own the imported repository.

repositoryName (String!)

The name of the imported repository.

skipReleases (Boolean)

Whether to skip migrating releases for the repository.

sourceId (ID!)

The ID of the migration source.

sourceRepositoryUrl (URI)

The URL of the source repository.

targetRepoVisibility (String)

The visibility of the imported repository.

StatusCheckConfigurationInput

Required status check.

Поля ввода для StatusCheckConfigurationInput

ИмяОписание

context (String!)

The status check context name that must be present on the commit.

integrationId (Int)

The optional integration ID that this status check must originate from.

SubmitPullRequestReviewInput

Autogenerated input type of SubmitPullRequestReview.

Поля ввода для SubmitPullRequestReviewInput

ИмяОписание

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.

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

TagNamePatternParametersInput

Parameters to be used for the tag_name_pattern rule.

Поля ввода для TagNamePatternParametersInput

ИмяОписание

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

TeamDiscussionCommentOrder

Ways in which team discussion comment connections can be ordered.

Поля ввода для TeamDiscussionCommentOrder

ИмяОписание

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.

Поля ввода для TeamDiscussionOrder

ИмяОписание

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.

Поля ввода для TeamMemberOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (TeamMemberOrderField!)

The field to order team members by.

TeamOrder

Ways in which team connections can be ordered.

Поля ввода для TeamOrder

ИмяОписание

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.

Поля ввода для TeamRepositoryOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (TeamRepositoryOrderField!)

The field to order repositories by.

TransferIssueInput

Autogenerated input type of TransferIssue.

Поля ввода для TransferIssueInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

createLabelsIfMissing (Boolean)

Whether to create labels if they don't exist in the target repository (matched by name).

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.

Поля ввода для UnarchiveRepositoryInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The ID of the repository to unarchive.

UnfollowOrganizationInput

Autogenerated input type of UnfollowOrganization.

Поля ввода для UnfollowOrganizationInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

ID of the organization to unfollow.

UnfollowUserInput

Autogenerated input type of UnfollowUser.

Поля ввода для UnfollowUserInput

ИмяОписание

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.

Поля ввода для UnlinkRepositoryFromProjectInput

ИмяОписание

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.

Поля ввода для UnlockLockableInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockableId (ID!)

ID of the item to be unlocked.

UnmarkDiscussionCommentAsAnswerInput

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

Поля ввода для UnmarkDiscussionCommentAsAnswerInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

UnmarkFileAsViewedInput

Autogenerated input type of UnmarkFileAsViewed.

Поля ввода для UnmarkFileAsViewedInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

path (String!)

The path of the file to mark as unviewed.

pullRequestId (ID!)

The Node ID of the pull request.

UnmarkIssueAsDuplicateInput

Autogenerated input type of UnmarkIssueAsDuplicate.

Поля ввода для UnmarkIssueAsDuplicateInput

ИмяОписание

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.

Поля ввода для UnminimizeCommentInput

ИмяОписание

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.

Поля ввода для UnpinIssueInput

ИмяОписание

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.

Поля ввода для UnresolveReviewThreadInput

ИмяОписание

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.

Поля ввода для UpdateBranchProtectionRuleInput

ИмяОписание

allowsDeletions (Boolean)

Can this branch be deleted.

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

blocksCreations (Boolean)

Is branch creation a protected operation.

branchProtectionRuleId (ID!)

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

bypassForcePushActorIds ([ID!])

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

bypassPullRequestActorIds ([ID!])

A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.

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.

lockAllowsFetchAndMerge (Boolean)

Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing.

lockBranch (Boolean)

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

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.

requireLastPushApproval (Boolean)

Whether the most recent push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

requiredDeploymentEnvironments ([String!])

The list of required deployment environments.

requiredStatusCheckContexts ([String!])

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

requiredStatusChecks ([RequiredStatusCheckInput!])

The list of required status checks.

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.

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

requiresDeployments (Boolean)

Are successful deployments required before merging.

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

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, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.

UpdateCheckRunInput

Autogenerated input type of UpdateCheckRun.

Поля ввода для UpdateCheckRunInput

ИмяОписание

actions ([CheckRunAction!])

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

checkRunId (ID!)

The node of the check.

clientMutationId (String)

A unique identifier for the client performing the mutation.

completedAt (DateTime)

The time that the check run finished.

conclusion (CheckConclusionState)

The final conclusion of the check.

detailsUrl (URI)

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

externalId (String)

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

name (String)

The name of the check.

output (CheckRunOutput)

Descriptive details about the run.

repositoryId (ID!)

The node ID of the repository.

startedAt (DateTime)

The time that the check run began.

status (RequestableCheckStatusState)

The current status.

UpdateCheckSuitePreferencesInput

Autogenerated input type of UpdateCheckSuitePreferences.

Поля ввода для UpdateCheckSuitePreferencesInput

ИмяОписание

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The Node ID of the repository.

UpdateDiscussionCommentInput

Autogenerated input type of UpdateDiscussionComment.

Поля ввода для UpdateDiscussionCommentInput

ИмяОписание

body (String!)

The new contents of the comment body.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commentId (ID!)

The Node ID of the discussion comment to update.

UpdateDiscussionInput

Autogenerated input type of UpdateDiscussion.

Поля ввода для UpdateDiscussionInput

ИмяОписание

body (String)

The new contents of the discussion body.

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

The Node ID of the discussion to update.

title (String)

The new discussion title.

UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

Поля ввода для UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput

ИмяОписание

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.

policyValue (EnterpriseAllowPrivateRepositoryForkingPolicyValue)

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

settingValue (EnterpriseEnabledDisabledSettingValue!)

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

UpdateEnterpriseDefaultRepositoryPermissionSettingInput

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

Поля ввода для UpdateEnterpriseDefaultRepositoryPermissionSettingInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

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

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

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

UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

Поля ввода для UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseMembersCanCreateRepositoriesSettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseMembersCanDeleteIssuesSettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseMembersCanMakePurchasesSettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseOrganizationProjectsSettingInput

ИмяОписание

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.

UpdateEnterpriseOwnerOrganizationRoleInput

Autogenerated input type of UpdateEnterpriseOwnerOrganizationRole.

Поля ввода для UpdateEnterpriseOwnerOrganizationRoleInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the Enterprise which the owner belongs to.

organizationId (ID!)

The ID of the organization for membership change.

organizationRole (RoleInOrganization!)

The role to assume in the organization.

UpdateEnterpriseProfileInput

Autogenerated input type of UpdateEnterpriseProfile.

Поля ввода для UpdateEnterpriseProfileInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseRepositoryProjectsSettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseTeamDiscussionsSettingInput

ИмяОписание

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.

Поля ввода для UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput

ИмяОписание

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.

UpdateEnvironmentInput

Autogenerated input type of UpdateEnvironment.

Поля ввода для UpdateEnvironmentInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

environmentId (ID!)

The node ID of the environment.

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

waitTimer (Int)

The wait timer in minutes.

UpdateIpAllowListEnabledSettingInput

Autogenerated input type of UpdateIpAllowListEnabledSetting.

Поля ввода для UpdateIpAllowListEnabledSettingInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

UpdateIpAllowListEntryInput

Autogenerated input type of UpdateIpAllowListEntry.

Поля ввода для UpdateIpAllowListEntryInput

ИмяОписание

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

name (String)

An optional name for the IP allow list entry.

UpdateIpAllowListForInstalledAppsEnabledSettingInput

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

Поля ввода для UpdateIpAllowListForInstalledAppsEnabledSettingInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the owner.

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

UpdateIssueCommentInput

Autogenerated input type of UpdateIssueComment.

Поля ввода для UpdateIssueCommentInput

ИмяОписание

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.

Поля ввода для UpdateIssueInput

ИмяОписание

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. В течение периода предварительной версии API может изменяться без уведомления.

Поля ввода для UpdateLabelInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

color (String)

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

description (String)

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

id (ID!)

The Node ID of the label to be updated.

name (String)

The updated name of the label.

UpdateOrganizationAllowPrivateRepositoryForkingSettingInput

Autogenerated input type of UpdateOrganizationAllowPrivateRepositoryForkingSetting.

Поля ввода для UpdateOrganizationAllowPrivateRepositoryForkingSettingInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

forkingEnabled (Boolean!)

Enable forking of private repositories in the organization?.

organizationId (ID!)

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

UpdateOrganizationWebCommitSignoffSettingInput

Autogenerated input type of UpdateOrganizationWebCommitSignoffSetting.

Поля ввода для UpdateOrganizationWebCommitSignoffSettingInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization on which to set the web commit signoff setting.

webCommitSignoffRequired (Boolean!)

Enable signoff on web-based commits for repositories in the organization?.

UpdateParametersInput

Only allow users with bypass permission to update matching refs.

Поля ввода для UpdateParametersInput

ИмяОписание

updateAllowsFetchAndMerge (Boolean!)

Branch can pull changes from its upstream repository.

UpdateProjectCardInput

Autogenerated input type of UpdateProjectCard.

Поля ввода для UpdateProjectCardInput

ИмяОписание

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.

Поля ввода для UpdateProjectColumnInput

ИмяОписание

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.

Поля ввода для UpdateProjectInput

ИмяОписание

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.

UpdatePullRequestBranchInput

Autogenerated input type of UpdatePullRequestBranch.

Поля ввода для UpdatePullRequestBranchInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

expectedHeadOid (GitObjectID)

The head ref oid for the upstream branch.

pullRequestId (ID!)

The Node ID of the pull request.

UpdatePullRequestInput

Autogenerated input type of UpdatePullRequest.

Поля ввода для UpdatePullRequestInput

ИмяОписание

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.

Поля ввода для UpdatePullRequestReviewCommentInput

ИмяОписание

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.

Поля ввода для UpdatePullRequestReviewInput

ИмяОписание

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.

Поля ввода для UpdateRefInput

ИмяОписание

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 update multiple refs in a single operation preview. В течение периода предварительной версии API может изменяться без уведомления.

Поля ввода для UpdateRefsInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

refUpdates ([RefUpdate!]!)

A list of ref updates.

repositoryId (ID!)

The Node ID of the repository.

UpdateRepositoryInput

Autogenerated input type of UpdateRepository.

Поля ввода для UpdateRepositoryInput

ИмяОписание

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.

hasDiscussionsEnabled (Boolean)

Indicates if the repository should have the discussions feature enabled.

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.

UpdateRepositoryRulesetInput

Autogenerated input type of UpdateRepositoryRuleset.

Поля ввода для UpdateRepositoryRulesetInput

ИмяОписание

bypassActorIds ([ID!])

A list of Team or App IDs allowed to bypass rules in this ruleset.

bypassMode (RuleBypassMode)

The bypass mode for this ruleset.

clientMutationId (String)

A unique identifier for the client performing the mutation.

conditions (RepositoryRuleConditionsInput)

The list of conditions for this ruleset.

enforcement (RuleEnforcement)

The enforcement level for this ruleset.

name (String)

The name of the ruleset.

repositoryRulesetId (ID!)

The global relay id of the repository ruleset to be updated.

rules ([RepositoryRuleInput!])

The list of rules for this ruleset.

target (RepositoryRulesetTarget)

The target of the ruleset.

UpdateRepositoryWebCommitSignoffSettingInput

Autogenerated input type of UpdateRepositoryWebCommitSignoffSetting.

Поля ввода для UpdateRepositoryWebCommitSignoffSettingInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The ID of the repository to update.

webCommitSignoffRequired (Boolean!)

Indicates if the repository should require signoff on web-based commits.

UpdateSubscriptionInput

Autogenerated input type of UpdateSubscription.

Поля ввода для UpdateSubscriptionInput

ИмяОписание

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.

Поля ввода для UpdateTeamDiscussionCommentInput

ИмяОписание

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.

Поля ввода для UpdateTeamDiscussionInput

ИмяОписание

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. В течение периода предварительной версии API может изменяться без уведомления.

Поля ввода для UpdateTeamReviewAssignmentInput

ИмяОписание

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

enabled (Boolean!)

Turn on or off review assignment.

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

id (ID!)

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

notifyTeam (Boolean)

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

teamMemberCount (Int)

The number of team members to assign.

UpdateTeamsRepositoryInput

Autogenerated input type of UpdateTeamsRepository.

Поля ввода для UpdateTeamsRepositoryInput

ИмяОписание

clientMutationId (String)

A unique identifier for the client performing the mutation.

permission (RepositoryPermission!)

Permission that should be granted to the teams.

repositoryId (ID!)

Repository ID being granted access to.

teamIds ([ID!]!)

A list of teams being granted access. Limit: 10.

UpdateTopicsInput

Autogenerated input type of UpdateTopics.

Поля ввода для UpdateTopicsInput

ИмяОписание

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.

Поля ввода для UserStatusOrder

ИмяОписание

direction (OrderDirection!)

The ordering direction.

field (UserStatusOrderField!)

The field to order user statuses by.

WorkflowRunOrder

Ways in which lists of workflow runs can be ordered upon return.

Поля ввода для WorkflowRunOrder

ИмяОписание

direction (OrderDirection!)

The direction in which to order workflow runs by the specified field.

field (WorkflowRunOrderField!)

The field by which to order workflows.