Commit files

commitFiles(input: CommitFilesInput!): CommitFilesPayload!

Requires project.files.write.

Arguments

ArgumentTypeRequired
inputCommitFilesInput!Yes

Input fields

input

CommitFilesInput

FieldTypeRequiredDescription
projectReferenceStringNoProject ID or slug. Requires project.files.write.
fileReferences[String!]NoFile paths or UUIDs. Omit/null commits all pending changes; [] commits none.
branchReferenceStringNoBranch name or UUID. Omit/null selects main.
expectedVersionIdIDNoExpected persisted version UUID; requires exactly one selected file.
expectedVersionsJSONNoMap from file paths or UUIDs to expected persisted version UUIDs.

Response

Returns CommitFilesPayload!. Open the type for its fields and nested types.

FieldTypeDescription
successBoolean!
versions[FileCommitVersion!]!Versions that committed, including successful files in a partially conflicting batch.
conflicts[FileCommitConflict!]!Files whose stale preconditions retained their drafts; refresh and retry only these files.
problemFileCommitProblemStatus 409 for stale-version conflicts; null otherwise. Authentication, validation, and resource failures use GraphQL errors.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation CommitFiles($input: CommitFilesInput!) {
  commitFiles(input: $input) {
    success
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}