Search code examples
graphqlgithub-apirelaygithub-graphqlgraphql-relay

github graphql api, what does "clientMutationId" mean?


I saw clientMutationId field in example-strong-typing documentation.

mutation {
  addComment(input:{clientMutationId: 1234, subjectId: "MDA6SXNzdWUyMjcyMDA2MTT=", body: "Looks good to me!"}) {
    clientMutationId
    commentEdge {
      node {
        body
        repository {
          id
          name
          nameWithOwner
        }
        issue {
          number
        }
      }
    }
  }
}

what does clientMutationId mean? How can I generate it?


Solution

  • clientMutationId is not directly related with GraphQL but it is with graphql-relay.

    Check Understanding Relay Mutations for a better explanation.

    clientMutationId. This ID is generated by the Relay client behind the scenes to track the mutation's progress.