Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.

Esta versión de GitHub Enterprise se discontinuará el Esta versión de GitHub Enterprise se discontinuó el 2020-08-20. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener un mejor desempeño, más seguridad y nuevas características, actualiza a la última versión de GitHub Enterprise. Para obtener ayuda con la actualización, contacta al soporte de GitHub Enterprise.

Versión del artículo: Enterprise Server 2.18

Mutaciones

En este artículo

Acerca de las mutaciones

Cada modelo de GraphQL tiene un tipo de raíz tanto para consultas como para mutaciones. El tipo mutación define las operaciones de GraphQL que cambian los datos en el servidor. Es análogo a realizar verbos HTTP tales como POST, PATCH, y DELETE.

Para obtener más información, consulta la sección "Acerca de las mutaciones".

addAssigneesToAssignable

Adds assignees to an assignable object.

Campos de entrada

Campos de retorno

Nombre Descripción

assignable (Assignable)

The item that was assigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.


addComment

Adds a comment to an Issue or Pull Request.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

commentEdge (IssueCommentEdge)

The edge from the subject's comment connection.

subject (Node)

The subject.

timelineEdge (IssueTimelineItemEdge)

The edge from the subject's timeline connection.


addLabelsToLabelable

Adds labels to a labelable object.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was labeled.


addProjectCard

Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.

Campos de entrada

Campos de retorno

Nombre Descripción

cardEdge (ProjectCardEdge)

The edge from the ProjectColumn's card connection.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The ProjectColumn.


addProjectColumn

Adds a column to a Project.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The edge from the project's column connection.

project (Project)

The project.


addPullRequestReview

Adds a review to a Pull Request.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The newly created pull request review.

reviewEdge (PullRequestReviewEdge)

The edge from the pull request's review connection.


addPullRequestReviewComment

Adds a comment to a review.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (PullRequestReviewComment)

The newly created comment.

commentEdge (PullRequestReviewCommentEdge)

The edge from the review's comment connection.


addReaction

Adds a reaction to a subject.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

subject (Reactable)

The reactable subject.


addStar

Adds a star to a Starrable.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.


changeUserStatus

Update your status on GitHub.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.


clearLabelsFromLabelable

Clears all labels from a labelable object.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was unlabeled.


cloneProject

Creates a new project by cloning configuration from an existing project.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

jobStatusId (String)

The id of the JobStatus for populating cloned fields.

project (Project)

The new cloned project.


cloneTemplateRepository

Create a new repository with the same files and directory structure as a template repository.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


closeIssue

Close an issue.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was closed.


closePullRequest

Close a pull request.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was closed.


convertProjectCardNoteToIssue

Convert a project note card to one associated with a newly created issue.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


createBranchProtectionRule

Create a new branch protection rule.

Campos de entrada

Campos de retorno

Nombre Descripción

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createCheckRun

Create a check run.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createCheckSuite

Create a check suite.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

checkSuite (CheckSuite)

The newly created check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createContentAttachment

Create a content attachment.

Aviso de previsualización

createContentAttachment is available under the Create content attachments preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentAttachment (ContentAttachment)

The newly created content attachment.


createDeployment

Creates a new deployment event.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

autoMerged (Boolean)

True if the default branch has been auto-merged into the deployment ref.

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployment (Deployment)

The new deployment.


createDeploymentStatus

Create a deployment status.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentStatus (DeploymentStatus)

The new deployment status.


createIssue

Creates a new issue.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The new issue.


createLabel

Creates a new label.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The new label.


createProject

Creates a new project.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.


createPullRequest

Create a new pull request.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.


createRef

Create a new Git Ref.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The newly created ref.


createRepository

Create a new repository.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


createTeamDiscussion

Creates a new team discussion.

Aviso de previsualización

createTeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The new discussion.


createTeamDiscussionComment

Creates a new team discussion comment.

Aviso de previsualización

createTeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.


deleteBranchProtectionRule

Delete a branch protection rule.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteIssue

Deletes an Issue object.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the issue belonged to.


deleteIssueComment

Deletes an IssueComment object.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteLabel

Deletes a label.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteProject

Deletes a project.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (ProjectOwner)

The repository or organization the project was removed from.


deleteProjectCard

Deletes a project card.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

column (ProjectColumn)

The column the deleted card was in.

deletedCardId (ID)

The deleted card ID.


deleteProjectColumn

Deletes a project column.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedColumnId (ID)

The deleted column ID.

project (Project)

The project the deleted column was in.


deletePullRequestReview

Deletes a pull request review.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The deleted pull request review.


deletePullRequestReviewComment

Deletes a pull request review comment.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The pull request review the deleted comment belonged to.


deleteRef

Delete a Git Ref.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussion

Deletes a team discussion.

Aviso de previsualización

deleteTeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussionComment

Deletes a team discussion comment.

Aviso de previsualización

deleteTeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.


dismissPullRequestReview

Dismisses an approved or rejected pull request review.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.


importProject

Creates a new project by importing columns and a list of issues/PRs.

Aviso de previsualización

importProject is available under the Import project preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new Project!.


lockLockable

Lock a lockable object.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockedRecord (Lockable)

The item that was locked.


markPullRequestReadyForReview

Marks a pull request ready for review.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is ready for review.


mergeBranch

Merge a head into a branch.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeCommit (Commit)

The resulting merge Commit.


mergePullRequest

Merge a pull request.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was merged.


minimizeComment

Minimizes a comment on an Issue, Commit, Pull Request, or Gist.

Aviso de previsualización

minimizeComment is available under the Minimize comments preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

minimizedComment (Minimizable)

The comment that was minimized.


moveProjectCard

Moves a project card to another place.

Campos de entrada

Campos de retorno

Nombre Descripción

cardEdge (ProjectCardEdge)

The new edge of the moved card.

clientMutationId (String)

A unique identifier for the client performing the mutation.


moveProjectColumn

Moves a project column to another place.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The new edge of the moved column.


pinIssue

Pin an issue to a repository.

Aviso de previsualización

pinIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was pinned.


removeAssigneesFromAssignable

Removes assignees from an assignable object.

Campos de entrada

Campos de retorno

Nombre Descripción

assignable (Assignable)

The item that was unassigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.


removeLabelsFromLabelable

Removes labels from a Labelable object.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The Labelable the labels were removed from.


removeOutsideCollaborator

Removes outside collaborator from all repositories in an organization.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

removedUser (User)

The user that was removed as an outside collaborator.


removeReaction

Removes a reaction from a subject.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

subject (Reactable)

The reactable subject.


removeStar

Removes a star from a Starrable.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.


reopenIssue

Reopen a issue.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was opened.


reopenPullRequest

Reopen a pull request.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was reopened.


requestReviews

Set review requests on a pull request.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is getting requests.

requestedReviewersEdge (UserEdge)

The edge from the pull request to the requested reviewers.


rerequestCheckSuite

Rerequests an existing check suite.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.


resolveReviewThread

Marks a review thread as resolved.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


submitPullRequestReview

Submits a pending pull request review.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The submitted pull request review.


unlockLockable

Unlock a lockable object.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

unlockedRecord (Lockable)

The item that was unlocked.


unmarkIssueAsDuplicate

Unmark an issue as a duplicate of another issue.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

duplicate (IssueOrPullRequest)

The issue or pull request that was marked as a duplicate.


unminimizeComment

Unminimizes a comment on an Issue, Commit, Pull Request, or Gist.

Aviso de previsualización

unminimizeComment is available under the Minimize comments preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

unminimizedComment (Minimizable)

The comment that was unminimized.


unpinIssue

Unpin a pinned issue from a repository.

Aviso de previsualización

unpinIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was unpinned.


unresolveReviewThread

Marks a review thread as unresolved.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


updateBranchProtectionRule

Create a new branch protection rule.

Campos de entrada

Campos de retorno

Nombre Descripción

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.


updateCheckRun

Update a check run.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

checkRun (CheckRun)

The updated check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.


updateCheckSuitePreferences

Modifies the settings of an existing check suite.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.


updateIssue

Updates an Issue.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue.


updateIssueComment

Updates an IssueComment object.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueComment (IssueComment)

The updated comment.


updateLabel

Updates an existing label.

Aviso de previsualización

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

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The updated label.


updateProject

Updates an existing project.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.


updateProjectCard

Updates an existing project card.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


updateProjectColumn

Updates an existing project column.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.


updatePullRequest

Update a pull request.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.


updatePullRequestReview

Updates the body of a pull request review.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The updated pull request review.


updatePullRequestReviewComment

Updates a pull request review comment.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.


updateRef

Update a Git Ref.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The updated Ref.


updateRepository

Update information about a repository.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.


updateSubscription

Updates the state for subscribable subjects.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.


updateTeamDiscussion

Updates a team discussion.

Aviso de previsualización

updateTeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The updated discussion.


updateTeamDiscussionComment

Updates a discussion comment.

Aviso de previsualización

updateTeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The updated comment.


updateTopics

Replaces the repository's topics with the given topics.

Campos de entrada

Campos de retorno

Nombre Descripción

clientMutationId (String)

A unique identifier for the client performing the mutation.

invalidTopicNames ([String!])

Names of the provided topics that are not valid.

repository (Repository)

The updated repository.


Pregunta a una persona

¿No puedes encontrar lo que estás buscando?

Contáctanos