Update branch status check

updateBranchStatusCheck(branchId: ID!, checkName: String!, input: UpdateBranchStatusCheckInput!): BranchStatusCheck!

Requires project.files.write.

Arguments

ArgumentTypeRequiredDescription
branchIdID!YesBranch the check reports on. A missing branch and one the caller cannot read are both not found.
checkNameString!YesCheck name; the key of the check on its branch.
inputUpdateBranchStatusCheckInput!Yes

Input fields

input

UpdateBranchStatusCheckInput

FieldTypeRequiredDescription
statusStatusCheckStatus!YesState to report.
descriptionStringNoDescription of the result, at most 1000 characters.
externalUrlStringNoLink to the external result; a URL of at most 2000 characters.

Response

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

FieldType
idID!
branchIdID!
checkNameString!
statusStatusCheckStatus!
descriptionString
externalUrlString
startedAtString
completedAtString

All fields of BranchStatusCheck.

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

Example

graphql
mutation UpdateBranchStatusCheck($branchId: ID!, $checkName: String!, $input: UpdateBranchStatusCheckInput!) {
  updateBranchStatusCheck(branchId: $branchId, checkName: $checkName, input: $input) {
    id
    status
    createdAt
    updatedAt
    branchId
  }
}
json
{
  "branchId": "00000000-0000-4000-8000-000000000001",
  "checkName": "example",
  "input": {
    "status": "pending"
  }
}