Skip to main content

Esta versión de GitHub Enterprise Server se discontinuó el 2024-07-09. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise Server. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Los objetos de entrada se pueden describir como "objetos que admiten composición" porque incluyen un conjunto de campos de entrada que definen el objeto.

En este artículo

Acerca de los objetos de entrada

Los objetos de entrada se pueden describir como "objetos que admiten composición" porque incluyen un conjunto de campos de entrada que definen el objeto.

Por ejemplo, CommitAuthor toma un campo denominado emails. Proporcionar un valor para emails transforma CommitAuthor en una lista de objetos User que contienen esa dirección de correo electrónico. Tenga en cuenta que los objetos pueden tener objetos de entrada, mientras que en el caso de las mutaciones, los objetos de entrada son obligatorios.

Para obtener más información, vea «Formar llamados con GraphQl».

AbortQueuedMigrationsInput

Autogenerated input type of AbortQueuedMigrations.

Campos de entrada para AbortQueuedMigrationsInput

NombreDescripción

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.

Campos de entrada para AddAssigneesToAssignableInput

NombreDescripción

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.

Campos de entrada para AddCommentInput

NombreDescripción

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.

Campos de entrada para AddDiscussionCommentInput

NombreDescripción

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.

AddDiscussionPollVoteInput

Autogenerated input type of AddDiscussionPollVote.

Campos de entrada para AddDiscussionPollVoteInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pollOptionId (ID!)

The Node ID of the discussion poll option to vote for.

AddEnterpriseAdminInput

Autogenerated input type of AddEnterpriseAdmin.

Campos de entrada para AddEnterpriseAdminInput

NombreDescripción

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.

Campos de entrada para AddEnterpriseOrganizationMemberInput

NombreDescripción

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.

Campos de entrada para AddLabelsToLabelableInput

NombreDescripción

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.

Campos de entrada para AddProjectCardInput

NombreDescripción

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.

Campos de entrada para AddProjectColumnInput

NombreDescripción

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.

AddProjectV2DraftIssueInput

Autogenerated input type of AddProjectV2DraftIssue.

Campos de entrada para AddProjectV2DraftIssueInput

NombreDescripción

assigneeIds ([ID!])

The IDs of the assignees of the draft issue.

body (String)

The body of the draft issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to add the draft issue to.

title (String!)

The title of the draft issue. A project item can also be created by providing the URL of an Issue or Pull Request if you have access.

AddProjectV2ItemByIdInput

Autogenerated input type of AddProjectV2ItemById.

Campos de entrada para AddProjectV2ItemByIdInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentId (ID!)

The id of the Issue or Pull Request to add.

projectId (ID!)

The ID of the Project to add the item to.

AddPullRequestReviewCommentInput

Autogenerated input type of AddPullRequestReviewComment.

Campos de entrada para AddPullRequestReviewCommentInput

NombreDescripción

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.

Campos de entrada para AddPullRequestReviewInput

NombreDescripción

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.

Campos de entrada para AddPullRequestReviewThreadInput

NombreDescripción

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.

Campos de entrada para AddReactionInput

NombreDescripción

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.

Campos de entrada para AddStarInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to star.

AddUpvoteInput

Autogenerated input type of AddUpvote.

Campos de entrada para AddUpvoteInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

AddVerifiableDomainInput

Autogenerated input type of AddVerifiableDomain.

Campos de entrada para AddVerifiableDomainInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (URI!)

The URL of the domain.

ownerId (ID!)

The ID of the owner to add the domain to.

ApproveDeploymentsInput

Autogenerated input type of ApproveDeployments.

Campos de entrada para ApproveDeploymentsInput

NombreDescripción

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.

ApproveVerifiableDomainInput

Autogenerated input type of ApproveVerifiableDomain.

Campos de entrada para ApproveVerifiableDomainInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to approve.

ArchiveProjectV2ItemInput

Autogenerated input type of ArchiveProjectV2Item.

Campos de entrada para ArchiveProjectV2ItemInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the ProjectV2Item to archive.

projectId (ID!)

The ID of the Project to archive the item from.

ArchiveRepositoryInput

Autogenerated input type of ArchiveRepository.

Campos de entrada para ArchiveRepositoryInput

NombreDescripción

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.

Campos de entrada para AuditLogOrder

NombreDescripción

direction (OrderDirection)

The ordering direction.

field (AuditLogOrderField)

The field to order Audit Logs by.

ChangeUserStatusInput

Autogenerated input type of ChangeUserStatus.

Campos de entrada para ChangeUserStatusInput

NombreDescripción

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.

Campos de entrada para CheckAnnotationData

NombreDescripción

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.

Campos de entrada para CheckAnnotationRange

NombreDescripción

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.

Campos de entrada para CheckRunAction

NombreDescripción

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.

Campos de entrada para CheckRunFilter

NombreDescripción

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.

Campos de entrada para CheckRunOutput

NombreDescripción

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.

Campos de entrada para CheckRunOutputImage

NombreDescripción

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.

Campos de entrada para CheckSuiteAutoTriggerPreference

NombreDescripción

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.

Campos de entrada para CheckSuiteFilter

NombreDescripción

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.

Campos de entrada para ClearLabelsFromLabelableInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelableId (ID!)

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

ClearProjectV2ItemFieldValueInput

Autogenerated input type of ClearProjectV2ItemFieldValue.

Campos de entrada para ClearProjectV2ItemFieldValueInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to be cleared.

itemId (ID!)

The ID of the item to be cleared.

projectId (ID!)

The ID of the Project.

CloneProjectInput

Autogenerated input type of CloneProject.

Campos de entrada para CloneProjectInput

NombreDescripción

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.

Campos de entrada para CloneTemplateRepositoryInput

NombreDescripción

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.

Campos de entrada para CloseDiscussionInput

NombreDescripción

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.

Campos de entrada para CloseIssueInput

NombreDescripción

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.

Campos de entrada para ClosePullRequestInput

NombreDescripción

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.

Campos de entrada para CommitAuthor

NombreDescripción

emails ([String!])

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

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user will be returned. This field takes precedence over emails.

CommitContributionOrder

Ordering options for commit contribution connections.

Campos de entrada para CommitContributionOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (CommitContributionOrderField!)

The field by which to order commit contributions.

CommitMessage

A message to include with a new commit.

Campos de entrada para CommitMessage

NombreDescripción

body (String)

The body of the message.

headline (String!)

The headline of the message.

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"
}.

Campos de entrada para CommittableBranch

NombreDescripción

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.

ContributionOrder

Ordering options for contribution connections.

Campos de entrada para ContributionOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

ConvertProjectCardNoteToIssueInput

Autogenerated input type of ConvertProjectCardNoteToIssue.

Campos de entrada para ConvertProjectCardNoteToIssueInput

NombreDescripción

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.

Campos de entrada para ConvertPullRequestToDraftInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to convert to draft.

CopyProjectV2Input

Autogenerated input type of CopyProjectV2.

Campos de entrada para CopyProjectV2Input

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

includeDraftIssues (Boolean)

Include draft issues in the new project.

ownerId (ID!)

The owner ID of the new project.

projectId (ID!)

The ID of the source Project to copy.

title (String!)

The title of the project.

CreateAttributionInvitationInput

Autogenerated input type of CreateAttributionInvitation.

Campos de entrada para CreateAttributionInvitationInput

NombreDescripción

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.

Campos de entrada para CreateBranchProtectionRuleInput

NombreDescripción

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.

Campos de entrada para CreateCheckRunInput

NombreDescripción

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.

Campos de entrada para CreateCheckSuiteInput

NombreDescripción

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.

Campos de entrada para CreateCommitOnBranchInput

NombreDescripción

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.

Nota:

CreateDeploymentInput is available under the Deployments preview. Durante el período de versión preliminar, la API podría cambiar sin previo aviso.

Campos de entrada para CreateDeploymentInput

NombreDescripción

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.

Nota:

CreateDeploymentStatusInput is available under the Deployments preview. Durante el período de versión preliminar, la API podría cambiar sin previo aviso.

Campos de entrada para CreateDeploymentStatusInput

NombreDescripción

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.

Campos de entrada para CreateDiscussionInput

NombreDescripción

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.

Campos de entrada para CreateEnterpriseOrganizationInput

NombreDescripción

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.

Campos de entrada para CreateEnvironmentInput

NombreDescripción

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.

Campos de entrada para CreateIpAllowListEntryInput

NombreDescripción

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.

Campos de entrada para CreateIssueInput

NombreDescripción

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.

Nota:

CreateLabelInput is available under the Labels preview. Durante el período de versión preliminar, la API podría cambiar sin previo aviso.

Campos de entrada para CreateLabelInput

NombreDescripción

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.

Campos de entrada para CreateLinkedBranchInput

NombreDescripción

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.

Campos de entrada para CreateMigrationSourceInput

NombreDescripción

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.

Campos de entrada para CreateProjectInput

NombreDescripción

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.

CreateProjectV2FieldInput

Autogenerated input type of CreateProjectV2Field.

Campos de entrada para CreateProjectV2FieldInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

dataType (ProjectV2CustomFieldType!)

The data type of the field.

name (String!)

The name of the field.

projectId (ID!)

The ID of the Project to create the field in.

singleSelectOptions ([ProjectV2SingleSelectFieldOptionInput!])

Options for a single select field. At least one value is required if data_type is SINGLE_SELECT.

CreateProjectV2Input

Autogenerated input type of CreateProjectV2.

Campos de entrada para CreateProjectV2Input

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The owner ID to create the project under.

repositoryId (ID)

The repository to link the project to.

teamId (ID)

The team to link the project to. The team will be granted read permissions.

title (String!)

The title of the project.

CreatePullRequestInput

Autogenerated input type of CreatePullRequest.

Campos de entrada para CreatePullRequestInput

NombreDescripción

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.

Campos de entrada para CreateRefInput

NombreDescripción

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.

Campos de entrada para CreateRepositoryInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A short description of the new repository.

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

homepageUrl (URI)

The URL for a web page about this repository.

name (String!)

The name of the new repository.

ownerId (ID)

The ID of the owner for the new repository.

teamId (ID)

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

template (Boolean)

Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure.

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

CreateTeamDiscussionCommentInput

Autogenerated input type of CreateTeamDiscussionComment.

Campos de entrada para CreateTeamDiscussionCommentInput

NombreDescripción

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.

Campos de entrada para CreateTeamDiscussionInput

NombreDescripción

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.

Campos de entrada para DeleteBranchProtectionRuleInput

NombreDescripción

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.

Campos de entrada para DeleteDeploymentInput

NombreDescripción

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.

Campos de entrada para DeleteDiscussionCommentInput

NombreDescripción

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.

Campos de entrada para DeleteDiscussionInput

NombreDescripción

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.

Campos de entrada para DeleteEnvironmentInput

NombreDescripción

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.

Campos de entrada para DeleteIpAllowListEntryInput

NombreDescripción

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.

Campos de entrada para DeleteIssueCommentInput

NombreDescripción

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.

Campos de entrada para DeleteIssueInput

NombreDescripción

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.

Nota:

DeleteLabelInput is available under the Labels preview. Durante el período de versión preliminar, la API podría cambiar sin previo aviso.

Campos de entrada para DeleteLabelInput

NombreDescripción

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.

Campos de entrada para DeleteLinkedBranchInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

linkedBranchId (ID!)

The ID of the linked branch.

DeletePackageVersionInput

Autogenerated input type of DeletePackageVersion.

Campos de entrada para DeletePackageVersionInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

packageVersionId (ID!)

The ID of the package version to be deleted.

DeleteProjectCardInput

Autogenerated input type of DeleteProjectCard.

Campos de entrada para DeleteProjectCardInput

NombreDescripción

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.

Campos de entrada para DeleteProjectColumnInput

NombreDescripción

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.

Campos de entrada para DeleteProjectInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The Project ID to update.

DeleteProjectV2FieldInput

Autogenerated input type of DeleteProjectV2Field.

Campos de entrada para DeleteProjectV2FieldInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to delete.

DeleteProjectV2Input

Autogenerated input type of DeleteProjectV2.

Campos de entrada para DeleteProjectV2Input

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to delete.

DeleteProjectV2ItemInput

Autogenerated input type of DeleteProjectV2Item.

Campos de entrada para DeleteProjectV2ItemInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the item to be removed.

projectId (ID!)

The ID of the Project from which the item should be removed.

DeleteProjectV2WorkflowInput

Autogenerated input type of DeleteProjectV2Workflow.

Campos de entrada para DeleteProjectV2WorkflowInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

workflowId (ID!)

The ID of the workflow to be removed.

DeletePullRequestReviewCommentInput

Autogenerated input type of DeletePullRequestReviewComment.

Campos de entrada para DeletePullRequestReviewCommentInput

NombreDescripción

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.

Campos de entrada para DeletePullRequestReviewInput

NombreDescripción

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.

Campos de entrada para DeleteRefInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

refId (ID!)

The Node ID of the Ref to be deleted.

DeleteTeamDiscussionCommentInput

Autogenerated input type of DeleteTeamDiscussionComment.

Campos de entrada para DeleteTeamDiscussionCommentInput

NombreDescripción

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.

Campos de entrada para DeleteTeamDiscussionInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The discussion ID to delete.

DeleteVerifiableDomainInput

Autogenerated input type of DeleteVerifiableDomain.

Campos de entrada para DeleteVerifiableDomainInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to delete.

DeploymentOrder

Ordering options for deployment connections.

Campos de entrada para DeploymentOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (DeploymentOrderField!)

The field to order deployments by.

DisablePullRequestAutoMergeInput

Autogenerated input type of DisablePullRequestAutoMerge.

Campos de entrada para DisablePullRequestAutoMergeInput

NombreDescripción

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.

Campos de entrada para DiscussionOrder

NombreDescripción

direction (OrderDirection!)

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

field (DiscussionOrderField!)

The field by which to order discussions.

DiscussionPollOptionOrder

Ordering options for discussion poll option connections.

Campos de entrada para DiscussionPollOptionOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (DiscussionPollOptionOrderField!)

The field to order poll options by.

DismissPullRequestReviewInput

Autogenerated input type of DismissPullRequestReview.

Campos de entrada para DismissPullRequestReviewInput

NombreDescripción

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.

Campos de entrada para DismissRepositoryVulnerabilityAlertInput

NombreDescripción

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.

Campos de entrada para DraftPullRequestReviewComment

NombreDescripción

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.

Campos de entrada para DraftPullRequestReviewThread

NombreDescripción

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.

Campos de entrada para EnablePullRequestAutoMergeInput

NombreDescripción

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.

Campos de entrada para EnterpriseAdministratorInvitationOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

EnterpriseMemberOrder

Ordering options for enterprise member connections.

Campos de entrada para EnterpriseMemberOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

EnterpriseServerInstallationOrder

Ordering options for Enterprise Server installation connections.

Campos de entrada para EnterpriseServerInstallationOrder

NombreDescripción

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.

Campos de entrada para EnterpriseServerUserAccountEmailOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

EnterpriseServerUserAccountOrder

Ordering options for Enterprise Server user account connections.

Campos de entrada para EnterpriseServerUserAccountOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

EnterpriseServerUserAccountsUploadOrder

Ordering options for Enterprise Server user accounts upload connections.

Campos de entrada para EnterpriseServerUserAccountsUploadOrder

NombreDescripción

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.

Campos de entrada para FileAddition

NombreDescripción

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")
        }
      ]
    }.
    

Campos de entrada para FileChanges

NombreDescripción

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.

Campos de entrada para FileDeletion

NombreDescripción

path (String!)

The path to delete.

FollowOrganizationInput

Autogenerated input type of FollowOrganization.

Campos de entrada para FollowOrganizationInput

NombreDescripción

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.

Campos de entrada para FollowUserInput

NombreDescripción

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.

Campos de entrada para GistOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (GistOrderField!)

The field to order repositories by.

GrantEnterpriseOrganizationsMigratorRoleInput

Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.

Campos de entrada para GrantEnterpriseOrganizationsMigratorRoleInput

NombreDescripción

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.

Campos de entrada para GrantMigratorRoleInput

NombreDescripción

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.

Campos de entrada para ImportProjectInput

NombreDescripción

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.

Campos de entrada para IpAllowListEntryOrder

NombreDescripción

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.

Campos de entrada para IssueCommentOrder

NombreDescripción

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.

Campos de entrada para IssueFilters

NombreDescripción

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.

Campos de entrada para IssueOrder

NombreDescripción

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.

Campos de entrada para LabelOrder

NombreDescripción

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.

Campos de entrada para LanguageOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (LanguageOrderField!)

The field to order languages by.

LinkProjectV2ToRepositoryInput

Autogenerated input type of LinkProjectV2ToRepository.

Campos de entrada para LinkProjectV2ToRepositoryInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to link to the repository.

repositoryId (ID!)

The ID of the repository to link to the project.

LinkProjectV2ToTeamInput

Autogenerated input type of LinkProjectV2ToTeam.

Campos de entrada para LinkProjectV2ToTeamInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to link to the team.

teamId (ID!)

The ID of the team to link to the project.

LinkRepositoryToProjectInput

Autogenerated input type of LinkRepositoryToProject.

Campos de entrada para LinkRepositoryToProjectInput

NombreDescripción

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.

Campos de entrada para LockLockableInput

NombreDescripción

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.

Campos de entrada para MannequinOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (MannequinOrderField!)

The field to order mannequins by.

MarkDiscussionCommentAsAnswerInput

Autogenerated input type of MarkDiscussionCommentAsAnswer.

Campos de entrada para MarkDiscussionCommentAsAnswerInput

NombreDescripción

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.

Campos de entrada para MarkFileAsViewedInput

NombreDescripción

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.

Campos de entrada para MarkPullRequestReadyForReviewInput

NombreDescripción

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.

Campos de entrada para MergeBranchInput

NombreDescripción

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.

Campos de entrada para MergePullRequestInput

NombreDescripción

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.

Campos de entrada para MilestoneOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (MilestoneOrderField!)

The field to order milestones by.

MinimizeCommentInput

Autogenerated input type of MinimizeComment.

Campos de entrada para MinimizeCommentInput

NombreDescripción

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.

Campos de entrada para MoveProjectCardInput

NombreDescripción

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.

Campos de entrada para MoveProjectColumnInput

NombreDescripción

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.

Campos de entrada para OrgEnterpriseOwnerOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (OrgEnterpriseOwnerOrderField!)

The field to order enterprise owners by.

OrganizationOrder

Ordering options for organization connections.

Campos de entrada para OrganizationOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (OrganizationOrderField!)

The field to order organizations by.

PackageFileOrder

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

Campos de entrada para PackageFileOrder

NombreDescripción

direction (OrderDirection)

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

field (PackageFileOrderField)

The field in which to order package files by.

PackageOrder

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

Campos de entrada para PackageOrder

NombreDescripción

direction (OrderDirection)

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

field (PackageOrderField)

The field in which to order packages by.

PackageVersionOrder

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

Campos de entrada para PackageVersionOrder

NombreDescripción

direction (OrderDirection)

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

field (PackageVersionOrderField)

The field in which to order package versions by.

PinIssueInput

Autogenerated input type of PinIssue.

Campos de entrada para PinIssueInput

NombreDescripción

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.

Campos de entrada para ProjectCardImport

NombreDescripción

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.

Campos de entrada para ProjectColumnImport

NombreDescripción

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.

Campos de entrada para ProjectOrder

NombreDescripción

direction (OrderDirection!)

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

field (ProjectOrderField!)

The field in which to order projects by.

ProjectV2FieldOrder

Ordering options for project v2 field connections.

Campos de entrada para ProjectV2FieldOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (ProjectV2FieldOrderField!)

The field to order the project v2 fields by.

ProjectV2FieldValue

The values that can be used to update a field of an item inside a Project. Only 1 value can be updated at a time.

Campos de entrada para ProjectV2FieldValue

NombreDescripción

date (Date)

The ISO 8601 date to set on the field.

iterationId (String)

The id of the iteration to set on the field.

number (Float)

The number to set on the field.

singleSelectOptionId (String)

The id of the single select option to set on the field.

text (String)

The text to set on the field.

ProjectV2ItemFieldValueOrder

Ordering options for project v2 item field value connections.

Campos de entrada para ProjectV2ItemFieldValueOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (ProjectV2ItemFieldValueOrderField!)

The field to order the project v2 item field values by.

ProjectV2ItemOrder

Ordering options for project v2 item connections.

Campos de entrada para ProjectV2ItemOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (ProjectV2ItemOrderField!)

The field to order the project v2 items by.

ProjectV2Order

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

Campos de entrada para ProjectV2Order

NombreDescripción

direction (OrderDirection!)

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

field (ProjectV2OrderField!)

The field in which to order projects by.

ProjectV2SingleSelectFieldOptionInput

Represents a single select field option.

Campos de entrada para ProjectV2SingleSelectFieldOptionInput

NombreDescripción

color (ProjectV2SingleSelectFieldOptionColor!)

The display color of the option.

description (String!)

The description text of the option.

name (String!)

The name of the option.

ProjectV2ViewOrder

Ordering options for project v2 view connections.

Campos de entrada para ProjectV2ViewOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (ProjectV2ViewOrderField!)

The field to order the project v2 views by.

ProjectV2WorkflowOrder

Ordering options for project v2 workflows connections.

Campos de entrada para ProjectV2WorkflowOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (ProjectV2WorkflowsOrderField!)

The field to order the project v2 workflows by.

PullRequestOrder

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

Campos de entrada para PullRequestOrder

NombreDescripción

direction (OrderDirection!)

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

field (PullRequestOrderField!)

The field in which to order pull requests by.

ReactionOrder

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

Campos de entrada para ReactionOrder

NombreDescripción

direction (OrderDirection!)

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

field (ReactionOrderField!)

The field in which to order reactions by.

RefOrder

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

Campos de entrada para RefOrder

NombreDescripción

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.

Nota:

RefUpdate is available under the Update refs preview update multiple refs in a single operation preview. Durante el período de versión preliminar, la API podría cambiar sin previo aviso.

Campos de entrada para RefUpdate

NombreDescripción

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.

RegenerateVerifiableDomainTokenInput

Autogenerated input type of RegenerateVerifiableDomainToken.

Campos de entrada para RegenerateVerifiableDomainTokenInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to regenerate the verification token of.

RejectDeploymentsInput

Autogenerated input type of RejectDeployments.

Campos de entrada para RejectDeploymentsInput

NombreDescripción

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.

Campos de entrada para ReleaseOrder

NombreDescripción

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.

Campos de entrada para RemoveAssigneesFromAssignableInput

NombreDescripción

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.

Campos de entrada para RemoveEnterpriseAdminInput

NombreDescripción

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.

Campos de entrada para RemoveLabelsFromLabelableInput

NombreDescripción

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.

Campos de entrada para RemoveOutsideCollaboratorInput

NombreDescripción

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.

Campos de entrada para RemoveReactionInput

NombreDescripción

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.

Campos de entrada para RemoveStarInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to unstar.

RemoveUpvoteInput

Autogenerated input type of RemoveUpvote.

Campos de entrada para RemoveUpvoteInput

NombreDescripción

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.

Campos de entrada para ReopenDiscussionInput

NombreDescripción

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.

Campos de entrada para ReopenIssueInput

NombreDescripción

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.

Campos de entrada para ReopenPullRequestInput

NombreDescripción

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.

Campos de entrada para RepositoryInvitationOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

RepositoryMigrationOrder

Ordering options for repository migrations.

Campos de entrada para RepositoryMigrationOrder

NombreDescripción

direction (RepositoryMigrationOrderDirection!)

The ordering direction.

field (RepositoryMigrationOrderField!)

The field to order repository migrations by.

RepositoryOrder

Ordering options for repository connections.

Campos de entrada para RepositoryOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (RepositoryOrderField!)

The field to order repositories by.

RequestReviewsInput

Autogenerated input type of RequestReviews.

Campos de entrada para RequestReviewsInput

NombreDescripción

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.

RequiredStatusCheckInput

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

Campos de entrada para RequiredStatusCheckInput

NombreDescripción

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.

RerequestCheckSuiteInput

Autogenerated input type of RerequestCheckSuite.

Campos de entrada para RerequestCheckSuiteInput

NombreDescripción

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.

Campos de entrada para ResolveReviewThreadInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

threadId (ID!)

The ID of the thread to resolve.

RevertPullRequestInput

Autogenerated input type of RevertPullRequest.

Campos de entrada para RevertPullRequestInput

NombreDescripción

body (String)

The description of the revert pull request.

clientMutationId (String)

A unique identifier for the client performing the mutation.

draft (Boolean)

Indicates whether the revert pull request should be a draft.

pullRequestId (ID!)

The ID of the pull request to revert.

title (String)

The title of the revert pull request.

RevokeEnterpriseOrganizationsMigratorRoleInput

Autogenerated input type of RevokeEnterpriseOrganizationsMigratorRole.

Campos de entrada para RevokeEnterpriseOrganizationsMigratorRoleInput

NombreDescripción

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.

Campos de entrada para RevokeMigratorRoleInput

NombreDescripción

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.

SavedReplyOrder

Ordering options for saved reply connections.

Campos de entrada para SavedReplyOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (SavedReplyOrderField!)

The field to order saved replies by.

StarOrder

Ways in which star connections can be ordered.

Campos de entrada para StarOrder

NombreDescripción

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.

Campos de entrada para StartOrganizationMigrationInput

NombreDescripción

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.

Campos de entrada para StartRepositoryMigrationInput

NombreDescripción

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.

SubmitPullRequestReviewInput

Autogenerated input type of SubmitPullRequestReview.

Campos de entrada para SubmitPullRequestReviewInput

NombreDescripción

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.

TeamDiscussionCommentOrder

Ways in which team discussion comment connections can be ordered.

Campos de entrada para TeamDiscussionCommentOrder

NombreDescripción

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.

Campos de entrada para TeamDiscussionOrder

NombreDescripción

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.

Campos de entrada para TeamMemberOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (TeamMemberOrderField!)

The field to order team members by.

TeamOrder

Ways in which team connections can be ordered.

Campos de entrada para TeamOrder

NombreDescripción

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.

Campos de entrada para TeamRepositoryOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (TeamRepositoryOrderField!)

The field to order repositories by.

TransferIssueInput

Autogenerated input type of TransferIssue.

Campos de entrada para TransferIssueInput

NombreDescripción

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.

UnarchiveProjectV2ItemInput

Autogenerated input type of UnarchiveProjectV2Item.

Campos de entrada para UnarchiveProjectV2ItemInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the ProjectV2Item to unarchive.

projectId (ID!)

The ID of the Project to archive the item from.

UnarchiveRepositoryInput

Autogenerated input type of UnarchiveRepository.

Campos de entrada para UnarchiveRepositoryInput

NombreDescripción

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.

Campos de entrada para UnfollowOrganizationInput

NombreDescripción

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.

Campos de entrada para UnfollowUserInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

userId (ID!)

ID of the user to unfollow.

UnlinkProjectV2FromRepositoryInput

Autogenerated input type of UnlinkProjectV2FromRepository.

Campos de entrada para UnlinkProjectV2FromRepositoryInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to unlink from the repository.

repositoryId (ID!)

The ID of the repository to unlink from the project.

UnlinkProjectV2FromTeamInput

Autogenerated input type of UnlinkProjectV2FromTeam.

Campos de entrada para UnlinkProjectV2FromTeamInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to unlink from the team.

teamId (ID!)

The ID of the team to unlink from the project.

UnlinkRepositoryFromProjectInput

Autogenerated input type of UnlinkRepositoryFromProject.

Campos de entrada para UnlinkRepositoryFromProjectInput

NombreDescripción

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.

Campos de entrada para UnlockLockableInput

NombreDescripción

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.

Campos de entrada para UnmarkDiscussionCommentAsAnswerInput

NombreDescripción

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.

Campos de entrada para UnmarkFileAsViewedInput

NombreDescripción

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.

Campos de entrada para UnmarkIssueAsDuplicateInput

NombreDescripción

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.

Campos de entrada para UnminimizeCommentInput

NombreDescripción

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.

Campos de entrada para UnpinIssueInput

NombreDescripción

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.

Campos de entrada para UnresolveReviewThreadInput

NombreDescripción

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.

Campos de entrada para UpdateBranchProtectionRuleInput

NombreDescripción

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.

Campos de entrada para UpdateCheckRunInput

NombreDescripción

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.

Campos de entrada para UpdateCheckSuitePreferencesInput

NombreDescripción

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.

Campos de entrada para UpdateDiscussionCommentInput

NombreDescripción

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.

Campos de entrada para UpdateDiscussionInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseDefaultRepositoryPermissionSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseMembersCanCreateRepositoriesSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseMembersCanDeleteIssuesSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseMembersCanMakePurchasesSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseOrganizationProjectsSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseOwnerOrganizationRoleInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseProfileInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseRepositoryProjectsSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseTeamDiscussionsSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput

NombreDescripción

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.

Campos de entrada para UpdateEnvironmentInput

NombreDescripción

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.

Campos de entrada para UpdateIpAllowListEnabledSettingInput

NombreDescripción

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.

Campos de entrada para UpdateIpAllowListEntryInput

NombreDescripción

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.

Campos de entrada para UpdateIpAllowListForInstalledAppsEnabledSettingInput

NombreDescripción

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.

Campos de entrada para UpdateIssueCommentInput

NombreDescripción

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.

Campos de entrada para UpdateIssueInput

NombreDescripción

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.

Nota:

UpdateLabelInput is available under the Labels preview. Durante el período de versión preliminar, la API podría cambiar sin previo aviso.

Campos de entrada para UpdateLabelInput

NombreDescripción

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.

UpdateNotificationRestrictionSettingInput

Autogenerated input type of UpdateNotificationRestrictionSetting.

Campos de entrada para UpdateNotificationRestrictionSettingInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the owner on which to set the restrict notifications setting.

settingValue (NotificationRestrictionSettingValue!)

The value for the restrict notifications setting.

UpdateOrganizationAllowPrivateRepositoryForkingSettingInput

Autogenerated input type of UpdateOrganizationAllowPrivateRepositoryForkingSetting.

Campos de entrada para UpdateOrganizationAllowPrivateRepositoryForkingSettingInput

NombreDescripción

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.

Campos de entrada para UpdateOrganizationWebCommitSignoffSettingInput

NombreDescripción

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?.

UpdateProjectCardInput

Autogenerated input type of UpdateProjectCard.

Campos de entrada para UpdateProjectCardInput

NombreDescripción

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.

Campos de entrada para UpdateProjectColumnInput

NombreDescripción

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.

Campos de entrada para UpdateProjectInput

NombreDescripción

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.

UpdateProjectV2DraftIssueInput

Autogenerated input type of UpdateProjectV2DraftIssue.

Campos de entrada para UpdateProjectV2DraftIssueInput

NombreDescripción

assigneeIds ([ID!])

The IDs of the assignees of the draft issue.

body (String)

The body of the draft issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

draftIssueId (ID!)

The ID of the draft issue to update.

title (String)

The title of the draft issue.

UpdateProjectV2Input

Autogenerated input type of UpdateProjectV2.

Campos de entrada para UpdateProjectV2Input

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

closed (Boolean)

Set the project to closed or open.

projectId (ID!)

The ID of the Project to update.

public (Boolean)

Set the project to public or private.

readme (String)

Set the readme description of the project.

shortDescription (String)

Set the short description of the project.

title (String)

Set the title of the project.

UpdateProjectV2ItemFieldValueInput

Autogenerated input type of UpdateProjectV2ItemFieldValue.

Campos de entrada para UpdateProjectV2ItemFieldValueInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to be updated.

itemId (ID!)

The ID of the item to be updated.

projectId (ID!)

The ID of the Project.

value (ProjectV2FieldValue!)

The value which will be set on the field.

UpdateProjectV2ItemPositionInput

Autogenerated input type of UpdateProjectV2ItemPosition.

Campos de entrada para UpdateProjectV2ItemPositionInput

NombreDescripción

afterId (ID)

The ID of the item to position this item after. If omitted or set to null the item will be moved to top.

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the item to be moved.

projectId (ID!)

The ID of the Project.

UpdatePullRequestBranchInput

Autogenerated input type of UpdatePullRequestBranch.

Campos de entrada para UpdatePullRequestBranchInput

NombreDescripción

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.

Campos de entrada para UpdatePullRequestInput

NombreDescripción

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.

Campos de entrada para UpdatePullRequestReviewCommentInput

NombreDescripción

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.

Campos de entrada para UpdatePullRequestReviewInput

NombreDescripción

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.

Campos de entrada para UpdateRefInput

NombreDescripción

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.

Nota:

UpdateRefsInput is available under the Update refs preview update multiple refs in a single operation preview. Durante el período de versión preliminar, la API podría cambiar sin previo aviso.

Campos de entrada para UpdateRefsInput

NombreDescripción

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.

Campos de entrada para UpdateRepositoryInput

NombreDescripción

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.

UpdateRepositoryWebCommitSignoffSettingInput

Autogenerated input type of UpdateRepositoryWebCommitSignoffSetting.

Campos de entrada para UpdateRepositoryWebCommitSignoffSettingInput

NombreDescripción

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.

Campos de entrada para UpdateSubscriptionInput

NombreDescripción

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.

Campos de entrada para UpdateTeamDiscussionCommentInput

NombreDescripción

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.

Campos de entrada para UpdateTeamDiscussionInput

NombreDescripción

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.

Nota:

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. Durante el período de versión preliminar, la API podría cambiar sin previo aviso.

Campos de entrada para UpdateTeamReviewAssignmentInput

NombreDescripción

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.

Campos de entrada para UpdateTeamsRepositoryInput

NombreDescripción

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.

Campos de entrada para UpdateTopicsInput

NombreDescripción

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.

Campos de entrada para UserStatusOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (UserStatusOrderField!)

The field to order user statuses by.

VerifiableDomainOrder

Ordering options for verifiable domain connections.

Campos de entrada para VerifiableDomainOrder

NombreDescripción

direction (OrderDirection!)

The ordering direction.

field (VerifiableDomainOrderField!)

The field to order verifiable domains by.

VerifyVerifiableDomainInput

Autogenerated input type of VerifyVerifiableDomain.

Campos de entrada para VerifyVerifiableDomainInput

NombreDescripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to verify.

WorkflowRunOrder

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

Campos de entrada para WorkflowRunOrder

NombreDescripción

direction (OrderDirection!)

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

field (WorkflowRunOrderField!)

The field by which to order workflows.